Commit 4e18aa07 authored by Andre Freyssinet's avatar Andre Freyssinet

Javadoc enhancements and fixes.

parent 25efc57a
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2001 - ScalAgent Distributed Technologies
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* Initial developer(s): Sofiane Chibani
* Contributor(s): David Feliot, Nicolas Tachker
*/
package fr.dyade.aaa.jndi2.impl;
import javax.naming.CompositeName;
import javax.naming.NamingException;
/**
* Thrown when a naming context has not been found
* whereas its parent naming context contains a
* <code>ContextRecord</code> indicating that
* the naming context exists.
* This may happen in a distributed JNDI configuration
* when a naming context has not been
* locally created yet. For example if the context
* /A has been created on the server 0 and the context
* /A/B on the server 1. If the server 2 starts, it gets
* from the server 0 the naming context /A
* containing a <code>ContextRecord</code> named B.
* If a JNDI request is asked about B (e.g. bind /A/B/C)
* then the server 2 can't find the naming context B because
* it still didn't get the naming data from server 1. So a
* <code>MissingContextException</code> is thrown.
*/
public class MissingContextException extends NamingException {
/**
*
*/
private static final long serialVersionUID = 1L;
/**
* The identifier of the missing context
*/
private NamingContextId missingContextId;
private CompositeName name;
/**
* Constructs a <code>MissingContextException</code>.
*
* @param missingContextId the identifier of the missing context
*/
public MissingContextException(
NamingContextId missingContextId,
CompositeName name) {
this.missingContextId = missingContextId;
this.name = name;
}
public final NamingContextId getMissingContextId() {
return missingContextId;
}
public final CompositeName getName() {
return name;
}
public String toString() {
return '(' + super.toString() +
",missingContextId=" + missingContextId +
",name=" + name + ')';
}
}
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2001 - 2020 ScalAgent Distributed Technologies
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* Initial developer(s): Sofiane Chibani
* Contributor(s): David Feliot, Nicolas Tachker
*/
package fr.dyade.aaa.jndi2.impl;
import javax.naming.CompositeName;
import javax.naming.NamingException;
/**
* Thrown when a naming context has not been found
* whereas its parent naming context contains a
* <code>ContextRecord</code> indicating that
* the naming context exists.
* This may happen in a distributed JNDI configuration
* when a naming context has not been
* locally created yet. For example if the context
* /A has been created on the server 0 and the context
* /A/B on the server 1. If the server 2 starts, it gets
* from the server 0 the naming context /A
* containing a <code>ContextRecord</code> named B.
* If a JNDI request is asked about B (e.g. bind /A/B/C)
* then the server 2 can't find the naming context B because
* it still didn't get the naming data from server 1. So a
* <code>MissingContextException</code> is thrown.
*/
public class MissingContextException extends NamingException {
/** define serialVersionUID for interoperability */
private static final long serialVersionUID = 1L;
/** The identifier of the missing context */
private NamingContextId missingContextId;
private CompositeName name;
/**
* Constructs a <code>MissingContextException</code>.
*
* @param missingContextId the identifier of the missing context
* @param name the composite name.
*/
public MissingContextException(
NamingContextId missingContextId,
CompositeName name) {
this.missingContextId = missingContextId;
this.name = name;
}
public final NamingContextId getMissingContextId() {
return missingContextId;
}
public final CompositeName getName() {
return name;
}
public String toString() {
return '(' + super.toString() + ",missingContextId=" + missingContextId + ",name=" + name + ')';
}
}
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2001 - 2008 ScalAgent Distributed Technologies
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* Initial developer(s): Sofiane Chibani
* Contributor(s): David Feliot, Nicolas Tachker
*/
package fr.dyade.aaa.jndi2.impl;
import javax.naming.NameNotFoundException;
import javax.naming.NamingException;
/**
* Thrown when a <code>ContextRecord</code> has not been found
* in a naming context. This may happen if the name asked in the
* JNDI request doesn't exist. That's why this exception includes
* a <code>NameNotFoundException</code> ready to be thrown forward.
* But the missing record may be resolved. For example,
* in a distributed configuration a missing record may indicate
* that the local JNDI server (where the record is missing) is not
* up to date according to a remote server where the record has
* been created. In this case, instead of throwing a
* <code>NameNotFoundException</code> the JNDI request
* may be blocked until the update arrives
* and creates the missing record.
*/
public class MissingRecordException extends NamingException {
/** define serialVersionUID for interoperability */
private static final long serialVersionUID = 1L;
private NamingContextId namingContextId;
private Object ownerId;
private NameNotFoundException nnfe;
/**
* Constructs a <code>MissingRecordException</code>.
*
* @param namingContextId the identifier of the context where
* the record is missing.
*
* @param nnfe the naming exception to be thrown if the
* record really doesn't exist.
*/
public MissingRecordException(
NamingContextId namingContextId,
Object ownerId,
NameNotFoundException nnfe) {
this.namingContextId = namingContextId;
this.ownerId = ownerId;
this.nnfe = nnfe;
}
public final NamingContextId getNamingContextId() {
return namingContextId;
}
public final Object getOwnerId() {
return ownerId;
}
public final NameNotFoundException getNameNotFoundException() {
return nnfe;
}
}
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2001 - 2020 ScalAgent Distributed Technologies
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* Initial developer(s): Sofiane Chibani
* Contributor(s): David Feliot, Nicolas Tachker
*/
package fr.dyade.aaa.jndi2.impl;
import javax.naming.NameNotFoundException;
import javax.naming.NamingException;
/**
* Thrown when a <code>ContextRecord</code> has not been found
* in a naming context. This may happen if the name asked in the
* JNDI request doesn't exist. That's why this exception includes
* a <code>NameNotFoundException</code> ready to be thrown forward.
* But the missing record may be resolved. For example,
* in a distributed configuration a missing record may indicate
* that the local JNDI server (where the record is missing) is not
* up to date according to a remote server where the record has
* been created. In this case, instead of throwing a
* <code>NameNotFoundException</code> the JNDI request
* may be blocked until the update arrives
* and creates the missing record.
*/
public class MissingRecordException extends NamingException {
/** define serialVersionUID for interoperability */
private static final long serialVersionUID = 1L;
private NamingContextId namingContextId;
private Object ownerId;
private NameNotFoundException nnfe;
/**
* Constructs a <code>MissingRecordException</code>.
*
* @param namingContextId the identifier of the context where the record is missing.
* @param ownerId the owner.
* @param nnfe the naming exception to be thrown if the record really doesn't exist.
*/
public MissingRecordException(
NamingContextId namingContextId,
Object ownerId,
NameNotFoundException nnfe) {
this.namingContextId = namingContextId;
this.ownerId = ownerId;
this.nnfe = nnfe;
}
public final NamingContextId getNamingContextId() {
return namingContextId;
}
public final Object getOwnerId() {
return ownerId;
}
public final NameNotFoundException getNameNotFoundException() {
return nnfe;
}
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment