com.iplanet.am.sdk
クラス AMAttributeSchema

java.lang.Object
  上位を拡張 com.iplanet.am.sdk.AMAttributeSchema

推奨されていません。 This class has been deprecated. Please use com.sun.identity.sm.AttributeSchema.

public class AMAttributeSchema
extends Object

The class AMAttributeSchema provides the interfaces to obtain meta information about service configuration variable.


フィールドの概要
static int SYNTAX_BOOLEAN
          推奨されていません。 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
          推奨されていません。 The SYNTAX_DATE attribute syntax specifies that the attribute should be a date
static int SYNTAX_DECIMAL_NUMBER
          推奨されていません。 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
          推奨されていません。 The SYNTAX_DECIMAL_RANGE attribute syntax specifies that the attribute is a decimal number within a range.
static int SYNTAX_DN
          推奨されていません。 The SYNTAX_DN attribute syntax specifies that the attribute should be an LDAP distinguished name (DN).
static int SYNTAX_EMAIL
          推奨されていません。 The SYNTAX_EMAIL attribute syntax specifies that the attribute is a email address.
static int SYNTAX_ENCRYPTED_PASSWORD
          推奨されていません。 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
          推奨されていません。 The SYNTAX_NUMBER attribute syntax specifies that the attribute is a number.
static int SYNTAX_NUMBER_RANGE
          推奨されていません。 The SYNTAX_NUMBER_RANGE attribute syntax specifies that the attribute is a number within a range.
static int SYNTAX_NUMERIC
          推奨されていません。 The SYNTAX_NUMERIC attribute syntax specifies that the attribute is numeric, i.e., can have numbers only.
static int SYNTAX_PARAGRAPH
          推奨されていません。 The SYNTAX_PARAGRAPH attribute syntax specifies that the attribute should be a paragraph
static int SYNTAX_PASSWORD
          推奨されていません。 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
          推奨されていません。 The SYNTAX_PERCENT attribute syntax specifies that the attribute is a percentage.
static int SYNTAX_STRING
          推奨されていません。 The SYNTAX_STRING attribute syntax specifies that the attribute is of text type, i.e., can have any unicode characters
static int SYNTAX_URL
          推奨されていません。 The SYNTAX_URL attribute syntax specifies that the attribute is a URL.
static int SYNTAX_XML
          推奨されていません。 The SYNTAX_XML attribute syntax specifies that the attribute should be a XML blob
static int TYPE_LIST
          推奨されていません。 The TYPE_LIST attribute type specifies that the attribute can have multiple values, i.e., multi-valued attribute
static int TYPE_MULTIPLE_CHOICE
          推奨されていません。 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
          推奨されていません。 The TYPE_SIGNATURE attribute type specifies that the attribute is a signing attribute.
static int TYPE_SINGLE
          推奨されていません。 The TYPE_SINGLE attribute type specifies that the attribute can have only a single value
static int TYPE_SINGLE_CHOICE
          推奨されていません。 The TYPE_SINGLE_CHOICE attribute type specifies that the attribute can have value defined by the getChoiceValues method of AMAttributeSchema.
static int TYPE_VALIDATOR
          推奨されていません。 The VALIDATOR attribute type specifies that the attribute defines a attribute validator plugin.
static int UITYPE_BUTTON
          推奨されていません。 The UITYPE_BUTTON attribute type specifies that the attribute should be display as a button.
static int UITYPE_LINK
          推奨されていません。 The UITYPE_LINK attribute type specifies that the attribute should be display as a link.
static int UITYPE_RADIO
          推奨されていません。 The UITYPE_RADIO attribute type specifies that the attribute should be display as a radio button.
static int UITYPE_UNDEFINED
          推奨されていません。 The UITYPE_UNDEFINED attribute type specifies that the UI type is not defined.
 
コンストラクタの概要
protected AMAttributeSchema(com.sun.identity.sm.AttributeSchema as)
          推奨されていません。  
 
メソッドの概要
 String getAny()
          推奨されていません。 Method to get service specific attributes.
 String getChoiceValueI18NKey(String cValue)
          推奨されていません。 Given a choice value, this method returns the i18nKey for that choice value
 String[] getChoiceValues()
          推奨されていません。 If the attribute is of choice type, this method returns the possible values for the attribute; null otherwise
 String getCosQualifier()
          推奨されていません。 Returns the value of the cosQualifier for this attribute that is default or merge-schemes.
 Set getDefaultValues()
          推奨されていません。 The method returns the default value of the attribute;
 String getEndRange()
          推奨されていません。 Method to get ending range for possible values of the attribute
 String getFalseValue()
          推奨されていません。 Method to get string value for "FALSE"
 String getFalseValueI18NKey()
          推奨されていません。 Method to get the i18n Key for BooleanFalseValue.
 String getI18NKey()
          推奨されていません。 Returns I18N key to describe the configuration attribute.
 String getName()
          推奨されていません。 The method returns the name of the attribute
 String getPropertiesViewBeanURL()
          推奨されていません。 Returns URL of the view bean for the attribute.
 String getStartRange()
          推奨されていません。 Method to get starting range for possible values of the attribute
 int getSyntax()
          推奨されていません。 The method returns the syntax of the attribute i.e., string, boolean, distinguished name (String), numeric.
 String getTrueValue()
          推奨されていません。 Method to get the string value for "TRUE"
 String getTrueValueI18NKey()
          推奨されていません。 Method to get the i18n Key for BooleanTrueValue.
 int getType()
          推奨されていません。 The method returns the type of the attribute i.e., single, list or choice
 int getUIType()
          推奨されていません。 The method returns the UI type of the attribute i.e., link, button, ...
 void setI18NKey(String i18nKey)
          推奨されていません。 Set I18N key to describe the configuration attribute
 String toString()
          推奨されていません。 Method that returns the String representation of the AMAttributeSchema.
 

フィールドの詳細

TYPE_SINGLE

public static final int TYPE_SINGLE
推奨されていません。 
The TYPE_SINGLE attribute type specifies that the attribute can have only a single value

関連項目:
定数フィールド値

TYPE_LIST

public static final int TYPE_LIST
推奨されていません。 
The TYPE_LIST attribute type specifies that the attribute can have multiple values, i.e., multi-valued attribute

関連項目:
定数フィールド値

TYPE_SINGLE_CHOICE

public static final int TYPE_SINGLE_CHOICE
推奨されていません。 
The TYPE_SINGLE_CHOICE attribute type specifies that the attribute can have value defined by the getChoiceValues method of AMAttributeSchema.

関連項目:
定数フィールド値

TYPE_MULTIPLE_CHOICE

public static final int TYPE_MULTIPLE_CHOICE
推奨されていません。 
The TYPE_MULTIPLE_CHOICE attribute type specifies that the attribute can have multiple values defined by the getChoiceValues method of AMAttributeSchema.

関連項目:
定数フィールド値

TYPE_SIGNATURE

public static final int TYPE_SIGNATURE
推奨されていません。 
The TYPE_SIGNATURE attribute type specifies that the attribute is a signing attribute.

関連項目:
定数フィールド値

TYPE_VALIDATOR

public static final int TYPE_VALIDATOR
推奨されていません。 
The VALIDATOR attribute type specifies that the attribute defines a attribute validator plugin.

関連項目:
定数フィールド値

UITYPE_RADIO

public static final int UITYPE_RADIO
推奨されていません。 
The UITYPE_RADIO attribute type specifies that the attribute should be display as a radio button.

関連項目:
定数フィールド値

UITYPE_LINK

public static final int UITYPE_LINK
推奨されていません。 
The UITYPE_LINK attribute type specifies that the attribute should be display as a link.

関連項目:
定数フィールド値

UITYPE_BUTTON

public static final int UITYPE_BUTTON
推奨されていません。 
The UITYPE_BUTTON attribute type specifies that the attribute should be display as a button.

関連項目:
定数フィールド値

UITYPE_UNDEFINED

public static final int UITYPE_UNDEFINED
推奨されていません。 
The UITYPE_UNDEFINED attribute type specifies that the UI type is not defined.

関連項目:
定数フィールド値

SYNTAX_BOOLEAN

public static final int SYNTAX_BOOLEAN
推奨されていません。 
The SYNTAX_BOOLEAN attribute syntax specifies that the attribute is of boolean type, i.e., can have a value of either true or false

関連項目:
定数フィールド値

SYNTAX_EMAIL

public static final int SYNTAX_EMAIL
推奨されていません。 
The SYNTAX_EMAIL attribute syntax specifies that the attribute is a email address.

関連項目:
定数フィールド値

SYNTAX_URL

public static final int SYNTAX_URL
推奨されていません。 
The SYNTAX_URL attribute syntax specifies that the attribute is a URL.

関連項目:
定数フィールド値

SYNTAX_STRING

public static final int SYNTAX_STRING
推奨されていません。 
The SYNTAX_STRING attribute syntax specifies that the attribute is of text type, i.e., can have any unicode characters

関連項目:
定数フィールド値

SYNTAX_PASSWORD

public static final int SYNTAX_PASSWORD
推奨されていません。 
The SYNTAX_PASSWORD attribute syntax specifies that the attribute is of password type, will be used by UI to mask the password typed.

関連項目:
定数フィールド値

SYNTAX_NUMERIC

public static final int SYNTAX_NUMERIC
推奨されていません。 
The SYNTAX_NUMERIC attribute syntax specifies that the attribute is numeric, i.e., can have numbers only.

関連項目:
定数フィールド値

SYNTAX_NUMBER

public static final int SYNTAX_NUMBER
推奨されていません。 
The SYNTAX_NUMBER attribute syntax specifies that the attribute is a number.

関連項目:
定数フィールド値

SYNTAX_PERCENT

public static final int SYNTAX_PERCENT
推奨されていません。 
The SYNTAX_PERCENT attribute syntax specifies that the attribute is a percentage.

関連項目:
定数フィールド値

SYNTAX_NUMBER_RANGE

public static final int SYNTAX_NUMBER_RANGE
推奨されていません。 
The SYNTAX_NUMBER_RANGE attribute syntax specifies that the attribute is a number within a range.

関連項目:
定数フィールド値

SYNTAX_DECIMAL_RANGE

public static final int SYNTAX_DECIMAL_RANGE
推奨されていません。 
The SYNTAX_DECIMAL_RANGE attribute syntax specifies that the attribute is a decimal number within a range.

関連項目:
定数フィールド値

SYNTAX_DECIMAL_NUMBER

public static final int SYNTAX_DECIMAL_NUMBER
推奨されていません。 
The SYNTAX_DECIMAL_NUMBER attribute syntax specifies that the attribute is a floating point number, e.g., 1.5, 3.56, etc.

関連項目:
定数フィールド値

SYNTAX_DN

public static final int SYNTAX_DN
推奨されていません。 
The SYNTAX_DN attribute syntax specifies that the attribute should be an LDAP distinguished name (DN).

関連項目:
定数フィールド値

SYNTAX_PARAGRAPH

public static final int SYNTAX_PARAGRAPH
推奨されていません。 
The SYNTAX_PARAGRAPH attribute syntax specifies that the attribute should be a paragraph

関連項目:
定数フィールド値

SYNTAX_DATE

public static final int SYNTAX_DATE
推奨されていません。 
The SYNTAX_DATE attribute syntax specifies that the attribute should be a date

関連項目:
定数フィールド値

SYNTAX_XML

public static final int SYNTAX_XML
推奨されていません。 
The SYNTAX_XML attribute syntax specifies that the attribute should be a XML blob

関連項目:
定数フィールド値

SYNTAX_ENCRYPTED_PASSWORD

public static final int SYNTAX_ENCRYPTED_PASSWORD
推奨されていません。 
The SYNTAX_ENCRYPTED_PASSWORD attribute syntax specifies that the attribute is of password type, will be used by UI to mask the password typed.

関連項目:
定数フィールド値
コンストラクタの詳細

AMAttributeSchema

protected AMAttributeSchema(com.sun.identity.sm.AttributeSchema as)
推奨されていません。 
メソッドの詳細

getName

public String getName()
推奨されていません。 
The method returns the name of the attribute

戻り値:
name of the attribute

getType

public int getType()
推奨されていません。 
The method returns the type of the attribute i.e., single, list or choice

戻り値:
the type of the attribute.

getUIType

public int getUIType()
推奨されていません。 
The method returns the UI type of the attribute i.e., link, button, ...

戻り値:
the UI type of the attribute; UITYPE_UNDEFINED if the UI type is not defined for the attribute

getSyntax

public int getSyntax()
推奨されていません。 
The method returns the syntax of the attribute i.e., string, boolean, distinguished name (String), numeric.

戻り値:
syntax of the attribute

getCosQualifier

public String getCosQualifier()
推奨されていません。 
Returns the value of the cosQualifier for this attribute that is default or merge-schemes.

戻り値:
String value of cosQualifier.

getDefaultValues

public Set getDefaultValues()
推奨されていません。 
The method returns the default value of the attribute;

戻り値:
Set containing the default values of the attribute or Collections.EMPTY_SET otherwise

getChoiceValues

public String[] getChoiceValues()
推奨されていません。 
If the attribute is of choice type, this method returns the possible values for the attribute; null otherwise

戻り値:
String array of possible choice values; null otherwise

getChoiceValueI18NKey

public String getChoiceValueI18NKey(String cValue)
推奨されていません。 
Given a choice value, this method returns the i18nKey for that choice value

パラメータ:
cValue - the choice value
戻り値:
the i18N key corresponding to the choice value

getI18NKey

public String getI18NKey()
推奨されていません。 
Returns I18N key to describe the configuration attribute.

戻り値:
i18n index key to the resource bundle

setI18NKey

public void setI18NKey(String i18nKey)
                throws AMException
推奨されていません。 
Set I18N key to describe the configuration attribute

パラメータ:
i18nKey - value of i18nKey.
例外:
AMException

getStartRange

public String getStartRange()
推奨されていません。 
Method to get starting range for possible values of the attribute

戻り値:
starting range for the attribute value

getEndRange

public String getEndRange()
推奨されていません。 
Method to get ending range for possible values of the attribute

戻り値:
ending range for the attribute value

getAny

public String getAny()
推奨されていません。 
Method to get service specific attributes. It return the value of the "any" attribute, if set in the XML schema for the service

戻り値:
value of "any" attribute

getPropertiesViewBeanURL

public String getPropertiesViewBeanURL()
推奨されていません。 
Returns URL of the view bean for the attribute.

戻り値:
URL for view bean

getTrueValue

public String getTrueValue()
推奨されていません。 
Method to get the string value for "TRUE"

戻り値:
String for TRUE value

getTrueValueI18NKey

public String getTrueValueI18NKey()
推奨されていません。 
Method to get the i18n Key for BooleanTrueValue.

戻り値:
String i18nKey for TRUE value

getFalseValue

public String getFalseValue()
推奨されていません。 
Method to get string value for "FALSE"

戻り値:
String for FALSE value

getFalseValueI18NKey

public String getFalseValueI18NKey()
推奨されていません。 
Method to get the i18n Key for BooleanFalseValue.

戻り値:
String i18nKey for FALSE value.

toString

public String toString()
推奨されていません。 
Method that returns the String representation of the AMAttributeSchema.

オーバーライド:
クラス Object 内の toString
戻り値:
String representation of the AMAttributeSchema/