|
|||
PREV CLASS NEXT CLASS | |||
SUMMARY: |FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.epic.directory.EpicDirectory
Classes for accessing the ePIC directory
Field Summary | |
static int |
ADD_ATTRIBUTE
Operations settings for modifying entries |
static java.lang.String |
CN
Class Name |
static java.lang.String |
copyrightNotice
Copyright statement |
static int |
DELETE_ATTRIBUTE
|
static int |
REPLACE_ATTRIBUTE
|
Constructor Summary | |
EpicDirectory()
Constructs an EpicDirectory object and will create the initial directory using properties file referenced in the MQAOand creates the initial directory context. |
|
EpicDirectory(java.util.Properties environment)
Constructs an EpicDirectory object using information supplied in 'environment' and creates the initial directory context. |
Method Summary | |
void |
close()
Closes the initial directory context |
javax.naming.directory.DirContext |
create(java.lang.String dn,
javax.naming.directory.Attributes attributes)
Create an entry in the directory |
void |
delete(java.lang.String dn)
Delete an entry in the directory. |
javax.naming.directory.Attribute |
getAttribute(javax.naming.directory.Attributes attributes,
java.lang.String attributeId)
Returns an specific attribute from the attribute list. |
java.lang.String |
getAttributeId(javax.naming.directory.Attribute attribute)
Get the attribute id from an attribute |
javax.naming.NamingEnumeration |
getAttributeList(javax.naming.directory.Attributes attributes)
Retrieves an enumeration of the attributes in this attribute set |
int |
getAttributeListSize(javax.naming.directory.Attributes attributes)
Get the number of attributes in a given directory entry. |
java.lang.Object |
getAttributeValue(java.lang.String dn,
java.lang.String attributeId)
Retrieves a single attribute value associated with the distinguished name Assumes the attribute value is a single value, otherwise will return first value This method should not be used when more than one attribute Id is to be retrieved. |
java.util.Enumeration |
getAttributeValueList(javax.naming.directory.Attribute attribute)
Get the attribute value list for a particular attribute. |
int |
getAttributeValueListSize(javax.naming.directory.Attribute attribute)
Get the size of the attribute value list for a given attribute. |
java.lang.String |
getDN(java.lang.String base,
java.lang.String filter)
Returns the dn for the specifed filter. |
javax.naming.directory.Attribute |
getNextAttribute(javax.naming.NamingEnumeration attributeList)
Return the next attribute from the attribute list. |
java.lang.Object |
getNextAttributeValue(java.util.Enumeration attributeValueList)
Get the next attribute value from an attribute value list. |
javax.naming.directory.Attributes |
getNextDirectoryEntry(javax.naming.NamingEnumeration results)
Return the next directory entry from the search results |
static java.util.Properties |
getProperties(java.lang.String fileName)
Loads the the ePIC Directory properties file |
java.lang.Boolean |
isLoggingRequired(java.lang.String ePICAppId)
Determines whether logging is required for an ePIC Application. |
java.lang.Object |
lookup(java.lang.String dn)
Retrieves an object given its distinguished name. |
void |
modify(java.lang.String dn,
int modificationOp,
javax.naming.directory.Attributes attributes)
Modify directory attributes according to the modificationOp and Attributes. |
javax.naming.directory.Attributes |
read(java.lang.String dn)
Retrieve all attributes associated with the distinguished name. |
javax.naming.directory.Attributes |
read(java.lang.String dn,
java.lang.String[] returnAttrs)
Retrieves the attributes listed in returnAttrs associated with a distinguished name. |
javax.naming.NamingEnumeration |
search(java.lang.String base,
javax.naming.directory.Attributes matchingAttrs,
java.lang.String[] returnAttrs)
Search the directory using a base and matching attributes, DOES NOT WORK WITH SUN JNDI!!!! |
javax.naming.NamingEnumeration |
search(java.lang.String base,
java.lang.String filter,
int scope)
Search the directory using a base, filter, and scope. |
javax.naming.NamingEnumeration |
search(java.lang.String base,
java.lang.String filter,
java.lang.String[] returnAttrs,
int scope)
Search the directory using a base, filter, return attributes and scope. |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final int ADD_ATTRIBUTE
public static final int REPLACE_ATTRIBUTE
public static final int DELETE_ATTRIBUTE
public static final java.lang.String CN
public static final java.lang.String copyrightNotice
Constructor Detail |
public EpicDirectory() throws EpicDirectoryException
public EpicDirectory(java.util.Properties environment) throws EpicDirectoryException
Properties
- Contains LDAP server connection parametersMethod Detail |
public void close() throws EpicDirectoryException
public javax.naming.directory.DirContext create(java.lang.String dn, javax.naming.directory.Attributes attributes) throws EpicDirectoryException
String
- Distinguished Name representing the directory entry to be createdAttributes
- List of attributes to add to the directory entrypublic void delete(java.lang.String dn) throws EpicDirectoryException
String
- Distinguished Name representing the directory entry to be deletedpublic javax.naming.directory.Attribute getAttribute(javax.naming.directory.Attributes attributes, java.lang.String attributeId) throws EpicDirectoryException
Attributes
- List of attributesString
- Specific attribute id to retrievepublic java.lang.String getAttributeId(javax.naming.directory.Attribute attribute) throws EpicDirectoryException
Attribute
- Contains the attribute id + valuespublic javax.naming.NamingEnumeration getAttributeList(javax.naming.directory.Attributes attributes) throws EpicDirectoryException
Attributes
- List of attributespublic int getAttributeListSize(javax.naming.directory.Attributes attributes) throws EpicDirectoryException
Attributes
- Contains the enumeration of attributespublic java.lang.Object getAttributeValue(java.lang.String dn, java.lang.String attributeId) throws EpicDirectoryException
dn
- Distinguished name to be readattributeId
- attribute Id to be searchedpublic java.util.Enumeration getAttributeValueList(javax.naming.directory.Attribute attribute) throws EpicDirectoryException
Attribute
- Contains the attribute id and valuespublic int getAttributeValueListSize(javax.naming.directory.Attribute attribute) throws EpicDirectoryException
Attribute
- Contains the attribute id and valuespublic javax.naming.directory.Attribute getNextAttribute(javax.naming.NamingEnumeration attributeList) throws EpicDirectoryException
NamingEnumeration
- The set of attributespublic java.lang.Object getNextAttributeValue(java.util.Enumeration attributeValueList) throws EpicDirectoryException
Enumeration
- Contains the list of attribute valuespublic javax.naming.directory.Attributes getNextDirectoryEntry(javax.naming.NamingEnumeration results) throws EpicDirectoryException
NamingEnumeration
- Contains the set of directory entries from the searchpublic static java.util.Properties getProperties(java.lang.String fileName) throws EpicDirectoryException
String
- File name of the ePIC directory properties filepublic java.lang.Boolean isLoggingRequired(java.lang.String ePICAppId) throws EpicDirectoryException
String
- Contains the name of the ePIC Application Idpublic java.lang.Object lookup(java.lang.String dn) throws EpicDirectoryException
dn
- A non-null string name representing the distinguished namepublic void modify(java.lang.String dn, int modificationOp, javax.naming.directory.Attributes attributes) throws EpicDirectoryException
String
- The Distinguished Name representing the directory entry to be modifiedint
- modificationOp value, must be either ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, or DELETE_ATTRIBUTEAttributes
- The set of attributes used for the modification.public javax.naming.directory.Attributes read(java.lang.String dn) throws EpicDirectoryException
String
- A non-null string name representing the distinguished namepublic javax.naming.directory.Attributes read(java.lang.String dn, java.lang.String[] returnAttrs) throws EpicDirectoryException
String
- A non-null string name representing the distinguished nameString
- [] Contains the attributes ids to be returned. May be null.public javax.naming.NamingEnumeration search(java.lang.String base, java.lang.String filter, int scope) throws EpicDirectoryException
String
- A non-null string name of the base context to start the searchString
- A non-null string to use as the search filterint
- Search constraint value, must be either SUBTREE_SCOPE, ONELEVEL_SCOPE, or OBJECT_SCOPEpublic javax.naming.NamingEnumeration search(java.lang.String base, javax.naming.directory.Attributes matchingAttrs, java.lang.String[] returnAttrs) throws EpicDirectoryException
String
- A non-null string name of the context to searchAttributes
- The attributes to search for. If null, all attributes will be matched.String
- [] The attributes to be returned. If null, all attributes will be returned.public javax.naming.NamingEnumeration search(java.lang.String base, java.lang.String filter, java.lang.String[] returnAttrs, int scope) throws EpicDirectoryException
String
- A non-null string name of the base context to start the searchString
- A non-null string to use as the search filterString
- A string array containing return attributes. Returns all attributes if null.int
- Search constraint value, must be either SUBTREE_SCOPE, ONELEVEL_SCOPE, or OBJECT_SCOPEpublic java.lang.String getDN(java.lang.String base, java.lang.String filter) throws EpicDirectoryException
base
- java.lang.String - base dn where to begin searching for entry.
If multiple dn branches need to be specified, separate the dns with a semicolon (;).filter
- java.lang.String - filter that you wish to find dn for. i.e. "uid=Bob"
|
|||
PREV CLASS NEXT CLASS | |||
SUMMARY: | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |