|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.iplanet.am.sdk.AMAttributeSchema
com.sun.identity.sm.AttributeSchema
.
public class AMAttributeSchema
The class AMAttributeSchema
provides the interfaces to obtain
meta information about service configuration variable.
Field Summary | |
---|---|
static int |
SYNTAX_BOOLEAN
Deprecated. The SYNTAX_BOOLEAN attribute syntax specifies that the
attribute is of boolean type, i.e., can have a value of either
true or
false |
static int |
SYNTAX_DATE
Deprecated. The SYNTAX_DATE attribute syntax specifies that the
attribute should be a date |
static int |
SYNTAX_DECIMAL_NUMBER
Deprecated. The SYNTAX_DECIMAL_NUMBER attribute syntax specifies that
the attribute is a floating point number, e.g., 1.5, 3.56, etc. |
static int |
SYNTAX_DECIMAL_RANGE
Deprecated. The SYNTAX_DECIMAL_RANGE attribute syntax specifies that
the attribute is a decimal number within a range. |
static int |
SYNTAX_DN
Deprecated. The SYNTAX_DN attribute syntax specifies that the
attribute should be an LDAP distinguished name (DN). |
static int |
SYNTAX_EMAIL
Deprecated. The SYNTAX_EMAIL attribute syntax specifies that the
attribute is a email address. |
static int |
SYNTAX_ENCRYPTED_PASSWORD
Deprecated. The SYNTAX_ENCRYPTED_PASSWORD attribute syntax specifies
that the attribute is of password type, will be used by UI to mask the
password typed. |
static int |
SYNTAX_NUMBER
Deprecated. The SYNTAX_NUMBER attribute syntax specifies that the
attribute is a number. |
static int |
SYNTAX_NUMBER_RANGE
Deprecated. The SYNTAX_NUMBER_RANGE attribute syntax specifies that
the attribute is a number within a range. |
static int |
SYNTAX_NUMERIC
Deprecated. The SYNTAX_NUMERIC attribute syntax specifies that the
attribute is numeric, i.e., can have numbers only. |
static int |
SYNTAX_PARAGRAPH
Deprecated. The SYNTAX_PARAGRAPH attribute syntax specifies that the
attribute should be a paragraph |
static int |
SYNTAX_PASSWORD
Deprecated. The SYNTAX_PASSWORD attribute syntax specifies that the
attribute is of password type, will be used by UI to mask the password
typed. |
static int |
SYNTAX_PERCENT
Deprecated. The SYNTAX_PERCENT attribute syntax specifies that the
attribute is a percentage. |
static int |
SYNTAX_STRING
Deprecated. The SYNTAX_STRING attribute syntax specifies that the
attribute is of text type, i.e., can have any unicode characters |
static int |
SYNTAX_URL
Deprecated. The SYNTAX_URL attribute syntax specifies that the
attribute is a URL. |
static int |
SYNTAX_XML
Deprecated. The SYNTAX_XML attribute syntax specifies that the
attribute should be a XML blob |
static int |
TYPE_LIST
Deprecated. The TYPE_LIST attribute type specifies that the attribute
can have multiple values, i.e., multi-valued attribute |
static int |
TYPE_MULTIPLE_CHOICE
Deprecated. The TYPE_MULTIPLE_CHOICE attribute type specifies that the
attribute can have multiple values defined by the
getChoiceValues method of AMAttributeSchema . |
static int |
TYPE_SIGNATURE
Deprecated. The TYPE_SIGNATURE attribute type specifies that the
attribute is a signing attribute. |
static int |
TYPE_SINGLE
Deprecated. The TYPE_SINGLE attribute type specifies that the
attribute can have only a single value |
static int |
TYPE_SINGLE_CHOICE
Deprecated. The TYPE_SINGLE_CHOICE attribute type specifies that the
attribute can have value defined by the getChoiceValues
method of AMAttributeSchema . |
static int |
TYPE_VALIDATOR
Deprecated. The VALIDATOR attribute type specifies that the attribute
defines a attribute validator plugin. |
static int |
UITYPE_BUTTON
Deprecated. The UITYPE_BUTTON attribute type specifies that the
attribute should be display as a button. |
static int |
UITYPE_LINK
Deprecated. The UITYPE_LINK attribute type specifies that the
attribute should be display as a link. |
static int |
UITYPE_RADIO
Deprecated. The UITYPE_RADIO attribute type specifies that the
attribute should be display as a radio button. |
static int |
UITYPE_UNDEFINED
Deprecated. The UITYPE_UNDEFINED attribute type specifies that the UI
type is not defined. |
Constructor Summary | |
---|---|
protected |
AMAttributeSchema(com.sun.identity.sm.AttributeSchema as)
Deprecated. |
Method Summary | |
---|---|
String |
getAny()
Deprecated. Method to get service specific attributes. |
String |
getChoiceValueI18NKey(String cValue)
Deprecated. Given a choice value, this method returns the i18nKey for that choice value |
String[] |
getChoiceValues()
Deprecated. If the attribute is of choice type, this method returns the possible values for the attribute; null otherwise |
String |
getCosQualifier()
Deprecated. Returns the value of the cosQualifier for this attribute
that is default or merge-schemes. |
Set |
getDefaultValues()
Deprecated. The method returns the default value of the attribute; |
String |
getEndRange()
Deprecated. Method to get ending range for possible values of the attribute |
String |
getFalseValue()
Deprecated. Method to get string value for "FALSE" |
String |
getFalseValueI18NKey()
Deprecated. Method to get the i18n Key for BooleanFalseValue . |
String |
getI18NKey()
Deprecated. Returns I18N key to describe the configuration attribute. |
String |
getName()
Deprecated. The method returns the name of the attribute |
String |
getPropertiesViewBeanURL()
Deprecated. Returns URL of the view bean for the attribute. |
String |
getStartRange()
Deprecated. Method to get starting range for possible values of the attribute |
int |
getSyntax()
Deprecated. The method returns the syntax of the attribute i.e., string, boolean, distinguished name (String), numeric. |
String |
getTrueValue()
Deprecated. Method to get the string value for "TRUE" |
String |
getTrueValueI18NKey()
Deprecated. Method to get the i18n Key for BooleanTrueValue . |
int |
getType()
Deprecated. The method returns the type of the attribute i.e., single, list or choice |
int |
getUIType()
Deprecated. The method returns the UI type of the attribute i.e., link, button, ... |
void |
setI18NKey(String i18nKey)
Deprecated. Set I18N key to describe the configuration attribute |
String |
toString()
Deprecated. Method that returns the String representation of the AMAttributeSchema . |
Field Detail |
---|
public static final int TYPE_SINGLE
TYPE_SINGLE
attribute type specifies that the
attribute can have only a single value
public static final int TYPE_LIST
TYPE_LIST
attribute type specifies that the attribute
can have multiple values, i.e., multi-valued attribute
public static final int TYPE_SINGLE_CHOICE
TYPE_SINGLE_CHOICE
attribute type specifies that the
attribute can have value defined by the getChoiceValues
method of AMAttributeSchema
.
public static final int TYPE_MULTIPLE_CHOICE
TYPE_MULTIPLE_CHOICE
attribute type specifies that the
attribute can have multiple values defined by the
getChoiceValues
method of AMAttributeSchema
.
public static final int TYPE_SIGNATURE
TYPE_SIGNATURE
attribute type specifies that the
attribute is a signing attribute.
public static final int TYPE_VALIDATOR
VALIDATOR
attribute type specifies that the attribute
defines a attribute validator plugin.
public static final int UITYPE_RADIO
UITYPE_RADIO
attribute type specifies that the
attribute should be display as a radio button.
public static final int UITYPE_LINK
UITYPE_LINK
attribute type specifies that the
attribute should be display as a link.
public static final int UITYPE_BUTTON
UITYPE_BUTTON
attribute type specifies that the
attribute should be display as a button.
public static final int UITYPE_UNDEFINED
UITYPE_UNDEFINED
attribute type specifies that the UI
type is not defined.
public static final int SYNTAX_BOOLEAN
SYNTAX_BOOLEAN
attribute syntax specifies that the
attribute is of boolean type, i.e., can have a value of either
true
or
false
public static final int SYNTAX_EMAIL
SYNTAX_EMAIL
attribute syntax specifies that the
attribute is a email address.
public static final int SYNTAX_URL
SYNTAX_URL
attribute syntax specifies that the
attribute is a URL.
public static final int SYNTAX_STRING
SYNTAX_STRING
attribute syntax specifies that the
attribute is of text type, i.e., can have any unicode characters
public static final int SYNTAX_PASSWORD
SYNTAX_PASSWORD
attribute syntax specifies that the
attribute is of password type, will be used by UI to mask the password
typed.
public static final int SYNTAX_NUMERIC
SYNTAX_NUMERIC
attribute syntax specifies that the
attribute is numeric, i.e., can have numbers only.
public static final int SYNTAX_NUMBER
SYNTAX_NUMBER
attribute syntax specifies that the
attribute is a number.
public static final int SYNTAX_PERCENT
SYNTAX_PERCENT
attribute syntax specifies that the
attribute is a percentage.
public static final int SYNTAX_NUMBER_RANGE
SYNTAX_NUMBER_RANGE
attribute syntax specifies that
the attribute is a number within a range.
public static final int SYNTAX_DECIMAL_RANGE
SYNTAX_DECIMAL_RANGE
attribute syntax specifies that
the attribute is a decimal number within a range.
public static final int SYNTAX_DECIMAL_NUMBER
SYNTAX_DECIMAL_NUMBER
attribute syntax specifies that
the attribute is a floating point number, e.g., 1.5, 3.56, etc.
public static final int SYNTAX_DN
SYNTAX_DN
attribute syntax specifies that the
attribute should be an LDAP distinguished name (DN).
public static final int SYNTAX_PARAGRAPH
SYNTAX_PARAGRAPH
attribute syntax specifies that the
attribute should be a paragraph
public static final int SYNTAX_DATE
SYNTAX_DATE
attribute syntax specifies that the
attribute should be a date
public static final int SYNTAX_XML
SYNTAX_XML
attribute syntax specifies that the
attribute should be a XML blob
public static final int SYNTAX_ENCRYPTED_PASSWORD
SYNTAX_ENCRYPTED_PASSWORD
attribute syntax specifies
that the attribute is of password type, will be used by UI to mask the
password typed.
Constructor Detail |
---|
protected AMAttributeSchema(com.sun.identity.sm.AttributeSchema as)
Method Detail |
---|
public String getName()
public int getType()
public int getUIType()
UITYPE_UNDEFINED
if
the UI type is not defined for the attributepublic int getSyntax()
public String getCosQualifier()
cosQualifier
for this attribute
that is default or merge-schemes.
cosQualifier
.public Set getDefaultValues()
Collections.EMPTY_SET otherwise
public String[] getChoiceValues()
null
otherwise
public String getChoiceValueI18NKey(String cValue)
cValue
- the choice value
public String getI18NKey()
public void setI18NKey(String i18nKey) throws AMException
i18nKey
- value of i18nKey
.
AMException
public String getStartRange()
public String getEndRange()
public String getAny()
public String getPropertiesViewBeanURL()
public String getTrueValue()
public String getTrueValueI18NKey()
BooleanTrueValue
.
public String getFalseValue()
public String getFalseValueI18NKey()
BooleanFalseValue
.
public String toString()
AMAttributeSchema
.
toString
in class Object
AMAttributeSchema
/
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |