|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.wles.blm.BLMComponentManager com.wles.blm.BLMDirectoryManager
Manages operations on identity directories. Identity directories act as containers for users and groups. Each directory has its own attribute schema which defines which attributes may be assigned to subjects within the directory.
Use a BLMContextManager
to obtain an instance of a
BLMDirectoryManager
.
BLMContextManager
Method Summary | |
void |
addSchemaAttribute(java.lang.String aDirName,
java.lang.String attrName,
boolean isList)
Adds an attribute declaration to the directory's attribute schema. |
void |
create(java.lang.String aDirName)
Creates an identity directory |
java.lang.String |
filter(java.lang.String findPattern)
Finds directories matching the specified filter pattern. |
boolean |
find(java.lang.String cID,
java.lang.String name)
Check for the existense of a directory in a collection. |
java.lang.String |
findDirectIdentitiesMatchingPattern(java.lang.String queryPattern)
Finds direct identity directories matching the given query pattern. |
int |
getCount(java.lang.String cID)
Gets the size of a directory or attribute schema collection. |
java.lang.String[] |
getReport(java.lang.String cID)
Returns a report on a directory collection. |
java.lang.String[] |
getReport(java.lang.String cID,
int iStart,
int iCount)
Returns a report on a subset of a directory collection. |
java.lang.String |
getSchema(java.lang.String aDirName)
Get a collection of the attributes making up the specified directory's schema. |
AttributeElement |
getSchemaAttributeTemplate(java.lang.String aDirName,
java.lang.String attrName)
Get the attribute's template value for a directory's schema. |
AttributeElement[] |
getSchemaReport(java.lang.String cID)
Returns a report of the attribute schma collection. |
AttributeElement[] |
getSchemaReport(java.lang.String cID,
int iStart,
int iCount)
Returns a report on a subset of an attribute schema collection. |
java.lang.String |
queryWithoutPrefix(java.lang.String findPattern)
|
void |
release(java.lang.String cID)
Releases a reference to a directory or attribute schema collection. |
void |
remove(java.lang.String name)
Removes a directory from the system. |
void |
removeCascade(java.lang.String name)
Removes a directory and all associated entities from the system. |
void |
removeSchemaAttribute(java.lang.String aDirName,
java.lang.String attrName)
Removes an attribute declaration from the directory's attribute schema. |
void |
removeSchemaAttributeTemplate(java.lang.String aDirName,
java.lang.String attrName)
Removes the template value for a directory's schema. |
void |
rename(java.lang.String oldName,
java.lang.String newName)
Renames a Directory. |
void |
setSchemaAttributeTemplate(java.lang.String aDirName,
AttributeElement attrElem)
Set or reset the value of a templated attribute for a directory's attribute schema. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public void addSchemaAttribute(java.lang.String aDirName, java.lang.String attrName, boolean isList) throws com.wles.blm.BLMException
aDirName
- name of the DirectoryattrName
- name of the attribute to be added to the directory's schemaisList
- specifies if this is a multi-valued attribute
BLMException
public void create(java.lang.String aDirName) throws com.wles.blm.BLMException
create
in class BLMComponentManager
aDirName
- name of the Directory to be created
BLMException
public java.lang.String filter(java.lang.String findPattern) throws com.wles.blm.BLMException
filter
in class BLMComponentManager
findPattern
- pattern for the filter
com.wles.blm.BLMException
getReport(String cID)
,
getReport(String cID, int iStart, int iCount)
,
getCount(String CID)
,
release(String cID)
,
find(String cID, String name)
public boolean find(java.lang.String cID, java.lang.String name) throws com.wles.blm.BLMException
find
in class BLMComponentManager
cID
- directory collection IDname
- name of the Directory
BLMException
public java.lang.String findDirectIdentitiesMatchingPattern(java.lang.String queryPattern) throws com.wles.blm.BLMException
//dir/orgA!OrgB!*
- a direct directory will be //dir/OrgA!OrgB!MyDir1
but
NEITHER of //dir/OrgA!parentScopeDir
NOR
//dir/OrgA!OrgB!OrgC!childScopeDir1
.
queryPattern
- The query pattern to use. Currently only * and ? can be used for wild-cards.
BLMException
public int getCount(java.lang.String cID) throws com.wles.blm.BLMException
getCount
in class BLMComponentManager
cID
- ID of the collection
BLMException
public java.lang.String[] getReport(java.lang.String cID) throws com.wles.blm.BLMException
cID
- ID of the collection
BLMException
public java.lang.String[] getReport(java.lang.String cID, int iStart, int iCount) throws com.wles.blm.BLMException
cID
- ID of the collectioniStart
- the start index of subset to report oniCount
- the number of elements to include in the report
BLMException
public java.lang.String getSchema(java.lang.String aDirName) throws com.wles.blm.BLMException
aDirName
- directory name
BLMException
getSchemaReport(String cID)
,
getSchemaReport(String cID, int iStart, int iCount)
,
getCount(String cID)
,
release(String cID)
public AttributeElement getSchemaAttributeTemplate(java.lang.String aDirName, java.lang.String attrName) throws com.wles.blm.BLMException, BadParameterException
aDirName
- String name of the DirectoryattrName
- String name of the attribute to be mapped to the directory
AttributeElement
containing the default value.
BLMException
BadParameterException
public AttributeElement[] getSchemaReport(java.lang.String cID) throws com.wles.blm.BLMException, BadParameterException
cID
- attribute schema collection ID
AttributeElements
from the collection.
BLMException
BadParameterException
public AttributeElement[] getSchemaReport(java.lang.String cID, int iStart, int iCount) throws com.wles.blm.BLMException, BadParameterException
cID
- attribute schema collection IDiStart
- Start index in the collectioniCount
- Number of objects
AttributeElements
from the collection.
BLMException
BadParameterException
public java.lang.String queryWithoutPrefix(java.lang.String findPattern) throws com.wles.blm.BLMException
com.wles.blm.BLMException
public void release(java.lang.String cID) throws com.wles.blm.BLMException
null
collection id will cause all held collections to be released.
release
in class BLMComponentManager
cID
- ID of the collection
BLMException
public void remove(java.lang.String name) throws com.wles.blm.BLMException
remove
in class BLMComponentManager
name
- the directory to remove
com.wles.blm.BLMException
public void removeCascade(java.lang.String name) throws com.wles.blm.BLMException
name
- name of the Directory to be removed
BLMException
public void removeSchemaAttribute(java.lang.String aDirName, java.lang.String attrName) throws com.wles.blm.BLMException
aDirName
- name of the DirectoryattrName
- specifies the name of the attribute to remove from the schema
BLMException
public void removeSchemaAttributeTemplate(java.lang.String aDirName, java.lang.String attrName) throws com.wles.blm.BLMException
aDirName
- String name of the DirectoryattrName
- String name of the attribute template to remove
BLMException
public void rename(java.lang.String oldName, java.lang.String newName) throws com.wles.blm.BLMException
rename
in class BLMComponentManager
oldName
- old name of the directory to be renamednewName
- new name of the directory to be renamed
BLMException
public void setSchemaAttributeTemplate(java.lang.String aDirName, AttributeElement attrElem) throws com.wles.blm.BLMException, BadParameterException
addSchemaAttribute
method.
Use a blank or null
value to clear the template value.
aDirName
- name of the DirectoryattrElem
- an AttributeElement
containing the name and new default value
BLMException
BadParameterException
addSchemaAttribute(java.lang.String, java.lang.String, boolean)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |