|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.sun.identity.sm.AttributeSchema
The class AttributeSchema
provides methods to
access the schema of a configuration parameter. Also, it
provides methods to set default and choice values.
Inner Class Summary | |
static class |
AttributeSchema.Syntax
The class Syntax defines the syntax of the
schema attributes and provides static constants for
these types. |
static class |
AttributeSchema.Type
The class Type defines the types of
schema attributes and provides static constants for
these types. |
static class |
AttributeSchema.UIType
The class UIType defines the UI types of
schema attributes and provides static constants for
these types. |
Method Summary | |
void |
addChoiceValue(java.lang.String value,
java.lang.String i18nKey)
Adds a choice value and its i18n key to the existing set of choice values. |
void |
addDefaultValue(java.lang.String value)
Adds a default value to the existing set of default values. |
java.lang.String |
getAny()
Method to get service specific attributes. |
java.lang.String |
getChoiceValueI18NKey(java.lang.String cValue)
Returns the I18N key for the given choice value. |
java.lang.String[] |
getChoiceValues()
Returns the possible choice values for the attribute if the attribute type is either SINGLE_CHOICE
or MULTIPLE_CHOICE . |
java.lang.String |
getCosQualifier()
Returns the value of the cosQualifier for this attribute
that is default, overrid, operational or merge-cos. |
java.util.Set |
getDefaultValues()
Returns the default values of the attribute. |
java.lang.String |
getEndRange()
Returns the end range if the attribute syntax is either NUMBER_RANGE or DECIMAL_RANGE . |
java.lang.String |
getFalseValue()
Returns the string value for BooleanFalseValue. |
java.lang.String |
getFalseValueI18NKey()
Returns the I18N Key for BooleanFalseValue. |
java.lang.String |
getI18NKey()
Returns the I18N key to describe the configuration attribute. |
int |
getMaxValue()
Returns the maximum number of values for the attribute if the attribute is of type MULTIPLE_CHOICE . |
int |
getMinValue()
Returns the minimum number of values for the attribute if the attribute is of type MULTIPLE_CHOICE . |
java.lang.String |
getName()
Returns the name of the attribute. |
java.lang.String |
getPropertiesViewBeanURL()
Returns URL of the view bean for the attribute. |
java.lang.String |
getStartRange()
Returns the start range if the attribute syntax is either NUMBER_RANGE or DECIMAL_RANGE . |
AttributeSchema.Syntax |
getSyntax()
Returns the syntax of the attribute. |
java.lang.String |
getTrueValue()
Returns the string value for BooleanTrueValue. |
java.lang.String |
getTrueValueI18NKey()
Retruns the I18N Key for BooleanTrueValue. |
AttributeSchema.Type |
getType()
Returns the type of the attribute. |
AttributeSchema.UIType |
getUIType()
Returns the UI type of the attribute. |
java.lang.String |
getValidator()
Method to get the validator name for using to validate this service attribute |
boolean |
isOptional()
Checks if the attribute is an optional attribute. |
boolean |
isResourceNameAllowed()
Checks if the attribute allows to have resource name. |
boolean |
isServiceIdentifier()
Chekcs if the attribute is a service identifier (i.e., in the case of LDAP it would be the COS Specifier attribute). |
boolean |
isStatusAttribute()
Checkds if the attribute is a service's status attribute. |
void |
removeChoiceValue(java.lang.String value)
Removes the given value from the set of choice values. |
void |
removeDefaultValue(java.lang.String value)
Removes the given value from the set of default values. |
void |
removeDefaultValues()
Removes the all the default values for the attribute. |
void |
setAny(java.lang.String a)
Sets the ny attribute |
void |
setCosQualifier(java.lang.String cosq)
Sets the cosQualifier attribute |
void |
setDefaultValues(java.util.Set values)
Sets the default values of the attribute. |
void |
setEndRange(java.lang.String edRange)
Sets the endRange Attribute. |
void |
setI18NKey(java.lang.String i18nKey)
Sets the I18N key to describe the configuration attribute. |
void |
setMaxValue(java.lang.String maxV)
Sets the MaxValue attribute |
void |
setMinValue(java.lang.String minV)
Sets the MinValue attribute |
void |
setPropertiesViewBeanUR(java.lang.String prop)
Sets the PropertiesViewBeanURL attribute |
void |
setStartRange(java.lang.String stRange)
Sets the StartRange attribute |
void |
setSyntax(java.lang.String synt)
Sets the Syntax attribute. |
void |
setType(java.lang.String type)
Sets the type. |
void |
setUIType(java.lang.String uiType)
Sets the UIType attribute. |
void |
setValidator(java.lang.String valid)
Sets the Validator attribute |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public java.lang.String getName()
public AttributeSchema.Type getType()
public void setType(java.lang.String type) throws SMSException, SSOException
type
- to be changed toSMSException
- if an error is encountered when trying to
setSSOException
- if the SSO token is invalid or expiredpublic AttributeSchema.UIType getUIType()
public void setUIType(java.lang.String uiType) throws SMSException, SSOException
String
- UITypeSMSException
- if an error is encountered when trying to
set UIType to the attribute schemaSSOException
- if the SSO token is invalid or expiredpublic AttributeSchema.Syntax getSyntax()
public void setSyntax(java.lang.String synt) throws SMSException, SSOException
String
- syntaxSMSException
- if an error is encountered when trying to
set the attribute syntaxSSOException
- if the SSO token is invalid or expiredpublic java.lang.String getI18NKey()
public void setI18NKey(java.lang.String i18nKey) throws SMSException, SSOException
i18NKey
- the I18N key to describe the attributeSMSException
- if an error is encountered when trying to
set I18N key to the attribute schemaSSOException
- if the SSO token is invalid or expiredpublic java.lang.String getCosQualifier()
cosQualifier
for this attribute
that is default, overrid, operational or merge-cos.public void setCosQualifier(java.lang.String cosq) throws SMSException, SSOException
String
- cosQualifierSMSException
- if an error is encountered when trying to
setSSOException
- if the SSO token is invalid or expiredpublic java.util.Set getDefaultValues()
public void setDefaultValues(java.util.Set values) throws SMSException, SSOException
values
- the set of default valuesSMSException
- public void addDefaultValue(java.lang.String value) throws SMSException, SSOException
value
- the default value to addSMSException
- public void removeDefaultValues() throws SMSException, SSOException
value
- the default value to removeSMSException
- public void removeDefaultValue(java.lang.String value) throws SMSException, SSOException
value
- the default value to removeSMSException
- public java.lang.String[] getChoiceValues()
SINGLE_CHOICE
or MULTIPLE_CHOICE
.public java.lang.String getChoiceValueI18NKey(java.lang.String cValue)
public void addChoiceValue(java.lang.String value, java.lang.String i18nKey) throws SMSException, SSOException
value
- the choice value to addi18nKey
- the I18N key for the choice valueSMSException
- public void removeChoiceValue(java.lang.String value) throws SMSException, SSOException
value
- the choice value to removeSMSException
- public java.lang.String getStartRange()
NUMBER_RANGE
or DECIMAL_RANGE
.public void setStartRange(java.lang.String stRange) throws SMSException, SSOException
String
- startRangeSMSException
- if an error is encountered when trying to setSSOException
- if the SSO token is invalid or expiredpublic java.lang.String getEndRange()
NUMBER_RANGE
or DECIMAL_RANGE
.public void setEndRange(java.lang.String edRange) throws SMSException, SSOException
String
- endRangeSMSException
- if an error is encountered when trying to setSSOException
- if the SSO token is invalid or expiredpublic java.lang.String getValidator()
public void setValidator(java.lang.String valid) throws SMSException, SSOException
String
- validatorSMSException
- if an error is encountered when trying to setSSOException
- if the SSO token is invalid or expiredpublic int getMinValue()
MULTIPLE_CHOICE
.public void setMinValue(java.lang.String minV) throws SMSException, SSOException
String
- minValueSMSException
- if an error is encountered when trying to setSSOException
- if the SSO token is invalid or expiredpublic int getMaxValue()
MULTIPLE_CHOICE
.public void setMaxValue(java.lang.String maxV) throws SMSException, SSOException
String
- maxValueSMSException
- if an error is encountered when trying to setSSOException
- if the SSO token is invalid or expiredpublic java.lang.String getTrueValue()
public java.lang.String getTrueValueI18NKey()
public java.lang.String getFalseValue()
public java.lang.String getFalseValueI18NKey()
public boolean isOptional()
public boolean isServiceIdentifier()
public boolean isResourceNameAllowed()
public boolean isStatusAttribute()
public java.lang.String getAny()
public void setAny(java.lang.String a) throws SMSException, SSOException
String
- anySMSException
- if an error is encountered when trying to setSSOException
- if the SSO token is invalid or expiredpublic java.lang.String getPropertiesViewBeanURL()
public void setPropertiesViewBeanUR(java.lang.String prop) throws SMSException, SSOException
String
- newURLSMSException
- if an error is encountered when trying to setSSOException
- if the SSO token is invalid or expiredpublic java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |