org.sape.carbon.services.config.jndi
Interface JNDILinkNodeConfiguration

All Superinterfaces:
Configuration, LinkNodeConfiguration

public interface JNDILinkNodeConfiguration
extends LinkNodeConfiguration

This configuration interface defines properties to that describe how to connect to a JNDI directory that contains a configuration hierachy. In the basic case, only InitialContextFactory, ProviderUrl, and InitialContextName need to be specified. If anonymous access to the directory is not allowed, SecurityPrincipal and SecurityCredentials must also be specified. If other JNDI environment properties are required based on the specific JNDI provider, they can be listed in the Map EnvironmentProperties.

For advanced control of the names of JNDI attributes and the meaning of the values used by the JNDI config service, the values of NodeTypeAttributeName, FolderNodeTypeAttributeValue, DocumentNodeTypeAttributeValue, DocumentTypeAttributeName, LinkDocumentTypeAttributeValue, DocumentDocumentTypeAttributeValue, DocumentContectAttributeName, NodeNameAttributeName, and AttributeNameValueSeparator.

Copyright 2003 Sapient

Since:
carbon 2.0
Version:
$Revision: 1.8 $($Author: dvoet $ / $Date: 2003/12/11 14:20:44 $)
Author:
Douglas Voet, March 2003

Field Summary
static String AttributeNameValueSeparator
          Default value for the AttributeNameValueSeparator property
static String DocumentContectAttributeName
          Default value for the DocumentContectAttributeName property
static String DocumentDocumentTypeAttributeValue
          Default value for the DocumentDocumentTypeAttributeValue property
static String DocumentNodeTypeAttributeValue
          Default value for the DocumentNodeTypeAttributeValue property
static String DocumentTypeAttributeName
          Default value for the DocumentTypeAttributeName property
static String FolderNodeTypeAttributeValue
          Default value for the FolderNodeTypeAttributeValue property
static String LinkDocumentTypeAttributeValue
          Default value for the LinkDocumentTypeAttributeValue property
static String NodeNameAttributeName
          Default value for the NodeNameAttributeName property
static String NodeTypeAttributeName
          Default value for the NodeTypeAttributeName property
 
Method Summary
 String getAttributeNameValueSeparator()
          Gets the String that the directory uses to separate attributes and their values when they are represented as Strings
 String getDocumentContectAttributeName()
          Gets the name of the attribute that holds a document's content.
 String getDocumentDocumentTypeAttributeValue()
          Gets the value of the attribute named by DocumentTypeAttributeName that denotes that a context represents a document.
 String getDocumentNodeTypeAttributeValue()
          Gets the value of the attribute named by NodeTypeAttributeName that denotes that a context represents a ConfigurationDocument.
 String getDocumentTypeAttributeName()
          Gets the name of the attribute that determines if a document context is a link or a document.
 String getFolderNodeTypeAttributeValue()
          Gets the value of the attribute named by NodeTypeAttributeName that denotes that a context represents a Folder.
 InitialContextFactory getInitialContextFactory()
          Gets the InitialContextFactory used to access the directory
 String getLinkDocumentTypeAttributeValue()
          Gets the value of the attribute named by DocumentTypeAttributeName that denotes that a context represents a link.
 String getNodeNameAttributeName()
          Gets the name of the attribute that holds the name of the context.
 String getNodeTypeAttributeName()
          Gets the name of the attribute that determines if a context is a Folder or a ConfigurationDocument.
 String getTargetContextName()
          Gets the name of the context that is the target of the link.
 void setAttributeNameValueSeparator(String separator)
          Gets AttributeNameValueSeparator.
 void setDocumentContectAttributeName(String name)
          Sets DocumentContectAttributeName.
 void setDocumentDocumentTypeAttributeValue(String value)
          Sets DocumentDocumentTypeAttributeValue.
 void setDocumentNodeTypeAttributeValue(String value)
          Sets DocumentNodeTypeAttributeValue.
 void setDocumentTypeAttributeName(String name)
          Sets DocumentTypeAttributeName.
 void setFolderNodeTypeAttributeValue(String value)
          Sets FolderNodeTypeAttributeValue.
 void setInitialContextFactory(InitialContextFactory factory)
          Sets the InitialContextFactory used to access the directory
 void setLinkDocumentTypeAttributeValue(String value)
          Sets LinkDocumentTypeAttributeValue.
 void setNodeNameAttributeName(String name)
          Sets NodeNameAttributeName.
 void setNodeTypeAttributeName(String name)
          Sets NodeTypeAttributeName.
 void setTargetContextName(String name)
          Sets the name of the context that is the target of the link.
 
Methods inherited from interface org.sape.carbon.core.config.node.link.LinkNodeConfiguration
getLinkNodeFactoryClass, setLinkNodeFactoryClass
 
Methods inherited from interface org.sape.carbon.core.config.Configuration
clone, getConfigurationInterface, getConfigurationName, getDataStructure, getRootElement, isConfigurationWritable, setConfigurationName, setConfigurationReadOnly
 

Field Detail

NodeTypeAttributeName

public static final String NodeTypeAttributeName
Default value for the NodeTypeAttributeName property

See Also:
Constant Field Values

FolderNodeTypeAttributeValue

public static final String FolderNodeTypeAttributeValue
Default value for the FolderNodeTypeAttributeValue property

See Also:
Constant Field Values

DocumentNodeTypeAttributeValue

public static final String DocumentNodeTypeAttributeValue
Default value for the DocumentNodeTypeAttributeValue property

See Also:
Constant Field Values

DocumentTypeAttributeName

public static final String DocumentTypeAttributeName
Default value for the DocumentTypeAttributeName property

See Also:
Constant Field Values

LinkDocumentTypeAttributeValue

public static final String LinkDocumentTypeAttributeValue
Default value for the LinkDocumentTypeAttributeValue property

See Also:
Constant Field Values

DocumentDocumentTypeAttributeValue

public static final String DocumentDocumentTypeAttributeValue
Default value for the DocumentDocumentTypeAttributeValue property

See Also:
Constant Field Values

DocumentContectAttributeName

public static final String DocumentContectAttributeName
Default value for the DocumentContectAttributeName property

See Also:
Constant Field Values

NodeNameAttributeName

public static final String NodeNameAttributeName
Default value for the NodeNameAttributeName property

See Also:
Constant Field Values

AttributeNameValueSeparator

public static final String AttributeNameValueSeparator
Default value for the AttributeNameValueSeparator property

See Also:
Constant Field Values
Method Detail

getInitialContextFactory

public InitialContextFactory getInitialContextFactory()
Gets the InitialContextFactory used to access the directory


setInitialContextFactory

public void setInitialContextFactory(InitialContextFactory factory)
Sets the InitialContextFactory used to access the directory


getTargetContextName

public String getTargetContextName()
Gets the name of the context that is the target of the link. This can not be null or empty. An example for an LDAP directory would be "name=configRoot,dc=sapient,dc=com".

Returns:
String

setTargetContextName

public void setTargetContextName(String name)
Sets the name of the context that is the target of the link. This can not be null or empty. An example for an LDAP directory would be "name=configRoot,dc=sapient,dc=com".

Parameters:
name -

getNodeTypeAttributeName

public String getNodeTypeAttributeName()
Gets the name of the attribute that determines if a context is a Folder or a ConfigurationDocument.

Returns:
String

setNodeTypeAttributeName

public void setNodeTypeAttributeName(String name)
Sets NodeTypeAttributeName.

Parameters:
name -
See Also:
getNodeTypeAttributeName()

getFolderNodeTypeAttributeValue

public String getFolderNodeTypeAttributeValue()
Gets the value of the attribute named by NodeTypeAttributeName that denotes that a context represents a Folder.

Returns:
String

setFolderNodeTypeAttributeValue

public void setFolderNodeTypeAttributeValue(String value)
Sets FolderNodeTypeAttributeValue.

Parameters:
value -
See Also:
getFolderNodeTypeAttributeValue()

getDocumentNodeTypeAttributeValue

public String getDocumentNodeTypeAttributeValue()
Gets the value of the attribute named by NodeTypeAttributeName that denotes that a context represents a ConfigurationDocument.

Returns:
String

setDocumentNodeTypeAttributeValue

public void setDocumentNodeTypeAttributeValue(String value)
Sets DocumentNodeTypeAttributeValue.

Parameters:
value -
See Also:
getDocumentNodeTypeAttributeValue()

getDocumentTypeAttributeName

public String getDocumentTypeAttributeName()
Gets the name of the attribute that determines if a document context is a link or a document.

Returns:
String

setDocumentTypeAttributeName

public void setDocumentTypeAttributeName(String name)
Sets DocumentTypeAttributeName.

Parameters:
name -
See Also:
setDocumentTypeAttributeName(java.lang.String)

getLinkDocumentTypeAttributeValue

public String getLinkDocumentTypeAttributeValue()
Gets the value of the attribute named by DocumentTypeAttributeName that denotes that a context represents a link.

Returns:
String

setLinkDocumentTypeAttributeValue

public void setLinkDocumentTypeAttributeValue(String value)
Sets LinkDocumentTypeAttributeValue.

Parameters:
value -
See Also:
setLinkDocumentTypeAttributeValue(java.lang.String)

getDocumentDocumentTypeAttributeValue

public String getDocumentDocumentTypeAttributeValue()
Gets the value of the attribute named by DocumentTypeAttributeName that denotes that a context represents a document.

Returns:
String

setDocumentDocumentTypeAttributeValue

public void setDocumentDocumentTypeAttributeValue(String value)
Sets DocumentDocumentTypeAttributeValue.

Parameters:
value -
See Also:
setDocumentDocumentTypeAttributeValue(java.lang.String)

getDocumentContectAttributeName

public String getDocumentContectAttributeName()
Gets the name of the attribute that holds a document's content.

Returns:
String

setDocumentContectAttributeName

public void setDocumentContectAttributeName(String name)
Sets DocumentContectAttributeName.

Parameters:
name -
See Also:
setDocumentContectAttributeName(java.lang.String)

getNodeNameAttributeName

public String getNodeNameAttributeName()
Gets the name of the attribute that holds the name of the context.

Returns:
String

setNodeNameAttributeName

public void setNodeNameAttributeName(String name)
Sets NodeNameAttributeName.

Parameters:
name -
See Also:
setNodeNameAttributeName(java.lang.String)

getAttributeNameValueSeparator

public String getAttributeNameValueSeparator()
Gets the String that the directory uses to separate attributes and their values when they are represented as Strings

Returns:

setAttributeNameValueSeparator

public void setAttributeNameValueSeparator(String separator)
Gets AttributeNameValueSeparator.

Parameters:
separator -
See Also:
getAttributeNameValueSeparator()


Copyright 1999-2003 Sapient Corporation. All Rights Reserved.