|
|||||||||
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.BLMDeclarationManager
Manages declarations of constants, attributes, custom enumeration types and evaluation functions.
Unlike other ALES entities, declaration names are not case sensitive. i.e. abc == ABC.
Use a BLMContextManager
to obtain an instance of a
BLMDeclarationManager
.
BLMContextManager
Field Summary | |
static int |
ATTRIBUTE_KIND_ALL
Specifies any attribute kind. |
static int |
ATTRIBUTE_KIND_DYNAMIC
Specifies dynamic attributes. |
static int |
ATTRIBUTE_KIND_RESOURCE
Specifies resource attributes. |
static int |
ATTRIBUTE_KIND_SUBJECT
Specifies subject attributes. |
static java.lang.String |
ATTRIBUTE_TYPE_BOOLEAN
Specifies an attribute of type boolean. |
static java.lang.String |
ATTRIBUTE_TYPE_DATE
Specifies an attribute of type date. |
static java.lang.String |
ATTRIBUTE_TYPE_INTEGER
Specifies an attribute of type integer. |
static java.lang.String |
ATTRIBUTE_TYPE_IP_ADDRESS
Specifies an attribute of type IP address. |
static java.lang.String |
ATTRIBUTE_TYPE_STRING
Specifies an attribute of type string. |
static java.lang.String |
ATTRIBUTE_TYPE_TIME
Specifies an attribute of type time. |
static int |
CATEGORY_ALL
Specifies all declaration categories. |
static int |
CATEGORY_ASI
Specifies the ASI declaration category. |
static int |
CATEGORY_BUILTIN
Specifies the built-in declaration category. |
static int |
CATEGORY_CUSTOM
Specifies the custom declaration category. |
static int |
CONSTANT_KIND_ALL
Specifies any kind of constant declaration. |
static int |
CONSTANT_KIND_PRIVILEGE
Specifies privilege constant declarations. |
static int |
CONSTANT_KIND_RESOURCE
Speciifes resource constant declarations. |
static int |
CONSTANT_KIND_SUBJECT
Specifies subject constant declarations. |
static int |
CONSTANT_KIND_SUBJECT_GROUP
Specifies subject group constant declarations. |
static java.lang.String |
DECLARATION_KIND_ALL
Specifies any kind of declaration. |
static java.lang.String |
DECLARATION_KIND_ATTRIBUTE
Specifies declarations of attributes (credentials). |
static java.lang.String |
DECLARATION_KIND_CONSTANT
Specifies declarations of constants. |
static java.lang.String |
DECLARATION_KIND_ENUMERATION
Specifies declarations of enumerations. |
static java.lang.String |
DECLARATION_KIND_EVALUATION_FUNCTION
Specifies declarations of evaluation functions. |
static int |
FILTER_BY_NAME
Specifies to filter declarations by name. |
static int |
FILTER_BY_TYPE
Specifies to filter declarations by type. |
static int |
FILTER_BY_VALUE
Specifies to filter declarations by value. |
Method Summary | |
void |
create(java.lang.String kind,
java.lang.String name,
java.lang.String value)
Creates a new declaration. |
java.lang.String |
filter(int byWhat,
java.lang.String findPattern,
java.lang.String declKind,
int subKind,
int category)
Finds declarations matching the specified search criteria. |
boolean |
find(java.lang.String cID,
java.lang.String name)
Checks for a named declaration in a collection. |
int |
getCount(java.lang.String cID)
Gets the size of a declaration collection. |
java.lang.String |
getKind(java.lang.String name)
Gets the kind of a declaration. |
java.lang.String[] |
getReport(java.lang.String cID)
Returns a report of the declarations in the specified collection. |
java.lang.String[] |
getReport(java.lang.String cID,
int iStart,
int iCount)
Returns a report of the declarations in the specified collection. |
java.lang.String |
getType(java.lang.String name)
Gets the type of an attribute or constant declaration |
java.lang.String |
getUseType(java.lang.String name)
Get the useage model for a attribute declaration. |
java.lang.String |
getValue(java.lang.String name)
Gets the value of a declaration. |
java.lang.String |
queryWithoutPrefix(int byWhat,
java.lang.String findPattern,
java.lang.String declKind,
int subKind,
int category)
|
void |
release(java.lang.String cID)
Releases a declaration collection. |
void |
remove(java.lang.String name)
Removes a declaration. |
void |
rename(java.lang.String oldName,
java.lang.String newName)
Renames a declaration. |
void |
setUseageModel(java.lang.String name,
int useage)
Set the usage model for an attribute declaration |
void |
setValue(java.lang.String name,
java.lang.String value)
Sets value of a declaration. |
Methods inherited from class com.wles.blm.BLMComponentManager |
create, filter |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int ATTRIBUTE_KIND_ALL
public static final int ATTRIBUTE_KIND_DYNAMIC
public static final int ATTRIBUTE_KIND_RESOURCE
public static final int ATTRIBUTE_KIND_SUBJECT
public static final java.lang.String ATTRIBUTE_TYPE_BOOLEAN
public static final java.lang.String ATTRIBUTE_TYPE_DATE
public static final java.lang.String ATTRIBUTE_TYPE_INTEGER
public static final java.lang.String ATTRIBUTE_TYPE_IP_ADDRESS
public static final java.lang.String ATTRIBUTE_TYPE_STRING
public static final java.lang.String ATTRIBUTE_TYPE_TIME
public static final int CATEGORY_ALL
public static final int CATEGORY_ASI
public static final int CATEGORY_BUILTIN
public static final int CATEGORY_CUSTOM
public static final int CONSTANT_KIND_ALL
public static final int CONSTANT_KIND_PRIVILEGE
public static final int CONSTANT_KIND_RESOURCE
public static final int CONSTANT_KIND_SUBJECT
public static final int CONSTANT_KIND_SUBJECT_GROUP
public static final java.lang.String DECLARATION_KIND_ALL
public static final java.lang.String DECLARATION_KIND_ATTRIBUTE
public static final java.lang.String DECLARATION_KIND_CONSTANT
public static final java.lang.String DECLARATION_KIND_ENUMERATION
public static final java.lang.String DECLARATION_KIND_EVALUATION_FUNCTION
public static final int FILTER_BY_NAME
public static final int FILTER_BY_TYPE
public static final int FILTER_BY_VALUE
Method Detail |
public void create(java.lang.String kind, java.lang.String name, java.lang.String value) throws com.wles.blm.BLMException
kind
- specifies the kind of declaration to create, one of: DECLARATION_KIND_CONSTANT, DECLARATION_KIND_ENUMERATION, DECLARATION_KIND_ATTRIBUTE, DECLARATION_KIND_EVALUATION_FUNCTION
name
- name of the declarationvalue
- value of the declaration. If specifying a ASI string value, the value must be enclosed in double quotes. When declaring attributes this field specifies the attribute data type, and may be set to one of ATTRIBUTE_TYPE_STRING, ATTRIBUTE_TYPE_INTEGER, ATTRIBUTE_TYPE_BOOLEAN, ATTRIBUTE_TYPE_IP_ADDRESS, ATTRIBUTE_TYPE_DATE, ATTRIBUTE_TYPE_TIME
or the name of a custom attribute enumeration type. When declaraing evaluation functions this field should be null
.
com.wles.blm.BLMException
DECLARATION_KIND_CONSTANT
,
DECLARATION_KIND_ENUMERATION
,
DECLARATION_KIND_ATTRIBUTE
,
DECLARATION_KIND_EVALUATION_FUNCTION
,
ATTRIBUTE_TYPE_STRING
,
ATTRIBUTE_TYPE_INTEGER
,
ATTRIBUTE_TYPE_BOOLEAN
,
ATTRIBUTE_TYPE_IP_ADDRESS
,
ATTRIBUTE_TYPE_DATE
,
ATTRIBUTE_TYPE_TIME
public java.lang.String filter(int byWhat, java.lang.String findPattern, java.lang.String declKind, int subKind, int category) throws com.wles.blm.BLMException
byWhat
- what part of a declaration to filter by, one of: FILTER_BY_NAME, FILTER_BY_TYPE, FILTER_BY_VALUE
findPattern
- Pattern for the filterdeclKind
- specifies the type of the declaration, one of: DECLARATION_KIND_CONSTANT, DECLARATION_KIND_ENUMERATION, DECLARATION_KIND_ATTRIBUTE, DECLARATION_KIND_EVALUATION_FUNCTION, DECLARATION_KIND_ALL
subKind
- available only when declaraing attributes and constants, and is ignored for
other search types. bitmask of of:
CONSTANT_KIND_PRIVILEGE, CONSTANT_KIND_SUBJECT, CONSTANT_KIND_SUBJECT, CONSTANT_KIND_RESOURCE, CONSTANT_KIND_SUBJECT_GROUP, CONSTANT_KIND_ALL
or
ATTRIBUTE_KIND_DYNAMIC, ATTRIBUTE_KIND_SUBJECT, ATTRIBUTE_KIND_RESOURCE, ATTRIBUTE_KIND_ALL
category
- bitmask of: CATEGORY_BUILTIN, CATEGORY_ASI, CATEGORY_CUSTOM, CATEGORY_ALL
, specifies who created this declaration.
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)
,
FILTER_BY_NAME
,
FILTER_BY_TYPE
,
FILTER_BY_VALUE
,
DECLARATION_KIND_CONSTANT
,
DECLARATION_KIND_ENUMERATION
,
DECLARATION_KIND_ATTRIBUTE
,
DECLARATION_KIND_EVALUATION_FUNCTION
,
DECLARATION_KIND_ALL
,
CONSTANT_KIND_PRIVILEGE
,
CONSTANT_KIND_SUBJECT
,
CONSTANT_KIND_SUBJECT
,
CONSTANT_KIND_RESOURCE
,
CONSTANT_KIND_SUBJECT_GROUP
,
CONSTANT_KIND_ALL
,
ATTRIBUTE_KIND_DYNAMIC
,
ATTRIBUTE_KIND_SUBJECT
,
ATTRIBUTE_KIND_RESOURCE
,
ATTRIBUTE_KIND_ALL
,
CATEGORY_BUILTIN
,
CATEGORY_ASI
,
CATEGORY_CUSTOM
,
CATEGORY_ALL
public boolean find(java.lang.String cID, java.lang.String name) throws com.wles.blm.BLMException
find
in class BLMComponentManager
cID
- collection ID of the collectionname
- name of the declaration
com.wles.blm.BLMException
public int getCount(java.lang.String cID) throws com.wles.blm.BLMException
getCount
in class BLMComponentManager
cID
- ID of the collection
com.wles.blm.BLMException
public java.lang.String getKind(java.lang.String name) throws com.wles.blm.BLMException
name
- name of the declaration
DECLARATION_KIND_CONSTANT, DECLARATION_KIND_ENUMERATION, DECLARATION_KIND_ATTRIBUTE, DECLARATION_KIND_EVALUATION_FUNCTION
com.wles.blm.BLMException
DECLARATION_KIND_CONSTANT
,
DECLARATION_KIND_ENUMERATION
,
DECLARATION_KIND_ATTRIBUTE
,
DECLARATION_KIND_EVALUATION_FUNCTION
public java.lang.String[] getReport(java.lang.String cID) throws com.wles.blm.BLMException
cID
- the collection id
com.wles.blm.BLMException
public java.lang.String[] getReport(java.lang.String cID, int iStart, int iCount) throws com.wles.blm.BLMException
cID
- the collection idiStart
- the start index to report oniCount
- the number of elements to include in the report
com.wles.blm.BLMException
public java.lang.String getType(java.lang.String name) throws com.wles.blm.BLMException
name
- name of the declaration
ATTRIBUTE_TYPE_STRING, ATTRIBUTE_TYPE_INTEGER, ATTRIBUTE_TYPE_BOOLEAN, ATTRIBUTE_TYPE_IP_ADDRESS, ATTRIBUTE_TYPE_DATE, ATTRIBUTE_TYPE_TIME
or the name of a custom attribute enumeration type.
com.wles.blm.BLMException
ATTRIBUTE_TYPE_STRING
,
ATTRIBUTE_TYPE_INTEGER
,
ATTRIBUTE_TYPE_BOOLEAN
,
ATTRIBUTE_TYPE_IP_ADDRESS
,
ATTRIBUTE_TYPE_DATE
,
ATTRIBUTE_TYPE_TIME
public java.lang.String getUseType(java.lang.String name) throws com.wles.blm.BLMException
name
- name of the declaration
ATTRIBUTE_KIND_DYNAMIC, ATTRIBUTE_KIND_SUBJECT, ATTRIBUTE_KIND_RESOURCE
com.wles.blm.BLMException
ATTRIBUTE_KIND_DYNAMIC
,
ATTRIBUTE_KIND_SUBJECT
,
ATTRIBUTE_KIND_RESOURCE
public java.lang.String getValue(java.lang.String name) throws com.wles.blm.BLMException
name
- name of the declaration
com.wles.blm.BLMException
public java.lang.String queryWithoutPrefix(int byWhat, java.lang.String findPattern, java.lang.String declKind, int subKind, int category) 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
com.wles.blm.BLMException
public void remove(java.lang.String name) throws com.wles.blm.BLMException
remove
in class BLMComponentManager
name
- name of the declaration to be removed
com.wles.blm.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 declarationnewName
- new name of the declaration
com.wles.blm.BLMException
public void setUseageModel(java.lang.String name, int useage) throws com.wles.blm.BLMException
name
- name of the credential declarationuseage
- useage kind to be set, one of: ATTRIBUTE_KIND_DYNAMIC, ATTRIBUTE_KIND_SUBJECT, ATTRIBUTE_KIND_RESOURCE
com.wles.blm.BLMException
ATTRIBUTE_KIND_DYNAMIC
,
ATTRIBUTE_KIND_SUBJECT
,
ATTRIBUTE_KIND_RESOURCE
public void setValue(java.lang.String name, java.lang.String value) throws com.wles.blm.BLMException
name
- name of the declarationvalue
- value to be set. If the declaration is an attribute this parameter specifies the attributes type, one of: ATTRIBUTE_TYPE_STRING, ATTRIBUTE_TYPE_INTEGER, ATTRIBUTE_TYPE_BOOLEAN, ATTRIBUTE_TYPE_IP_ADDRESS, ATTRIBUTE_TYPE_DATE, ATTRIBUTE_TYPE_TIME
or the name of a custom attribute enumeration type.
com.wles.blm.BLMException
ATTRIBUTE_TYPE_STRING
,
ATTRIBUTE_TYPE_INTEGER
,
ATTRIBUTE_TYPE_BOOLEAN
,
ATTRIBUTE_TYPE_IP_ADDRESS
,
ATTRIBUTE_TYPE_DATE
,
ATTRIBUTE_TYPE_TIME
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |