|
|||||||||
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[] |
getChoiceValues(java.util.Map envParams)
Returns the possible choice values for the attribute if the attribute type is either SINGLE_CHOICE
or MULTIPLE_CHOICE , for the given environment
parameters. |
java.lang.String |
getCosQualifier()
Returns the value of the cosQualifier for this attribute
that is default, override, operational or merge-cos . |
java.util.Set |
getDefaultValues()
Returns the default values of the attribute. |
java.util.Set |
getDefaultValues(java.util.Map envParams)
Returns the default values of the attribute for the given environment parameters. |
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. |
ServiceSchema |
getServiceSchema()
Returns Service Schema. |
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()
Returns 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()
Returns true if the attribute is an optional attribute. |
boolean |
isResourceNameAllowed()
Checks if the attribute allows to have resource name. |
boolean |
isSearchable()
Returns true if the attribute is searchable;
false otherwise |
boolean |
isServiceIdentifier()
Returns true if the attribute is a service identifier (i.e., in the case of LDAP it would be the COS Specifier attribute). |
boolean |
isStatusAttribute()
Returns true 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 any 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 end range Attribute. |
void |
setI18NKey(java.lang.String i18nKey)
Sets the I18N key to describe the configuration attribute. |
void |
setMaxValue(java.lang.String maxV)
Sets the maximum value attribute. |
void |
setMinValue(java.lang.String minV)
Sets the minimum value attribute. |
void |
setPropertiesViewBeanUR(java.lang.String prop)
Sets the URL of the view bean for the attribute. |
void |
setSearchable(java.lang.String value)
Sets the attribute isSearchable, if value is set to true
, or false . |
void |
setStartRange(java.lang.String stRange)
Sets the start range 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()
Returns a string representation of this AttributeSchema
object. |
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 ServiceSchema getServiceSchema()
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 single sign on token is invalid or expiredpublic AttributeSchema.UIType getUIType()
public void setUIType(java.lang.String uiType) throws SMSException, SSOException
UIType
attribute.uiType
- user interface type.SMSException
- if an error is encountered when trying to
set UIType
to the attribute schema.SSOException
- if the single sign on token is invalid or expiredpublic AttributeSchema.Syntax getSyntax()
public void setSyntax(java.lang.String synt) throws SMSException, SSOException
synt
- syntaxSMSException
- if an error is encountered when trying to
set the attribute syntaxSSOException
- if the single sign on 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 single sign on token is invalid or expiredpublic java.lang.String getCosQualifier()
cosQualifier
for this attribute
that is default, override, operational or merge-cos
.cosQualifier
.public void setCosQualifier(java.lang.String cosq) throws SMSException, SSOException
cosQualifier
attributecosq
- value of cosQualifier
.SMSException
- if an error is encountered when trying to set.SSOException
- if the single sign on token is invalid or expiredpublic java.util.Set getDefaultValues()
public java.util.Set getDefaultValues(java.util.Map envParams)
envParams
- Map of environment parameter to a set of valuespublic void setDefaultValues(java.util.Set values) throws SMSException, SSOException
values
- the set of default valuesSMSException
- if an error is encountered when trying to set.SSOException
- if the single sign on token is invalid or expiredpublic void addDefaultValue(java.lang.String value) throws SMSException, SSOException
value
- the default value to addSMSException
- if an error is encountered when trying to set.SSOException
- if the single sign on token is invalid or expiredpublic void removeDefaultValues() throws SMSException, SSOException
SMSException
- if an error is encountered when trying to set.SSOException
- if the single sign on token is invalid or expiredpublic void removeDefaultValue(java.lang.String value) throws SMSException, SSOException
value
- the default value to removeSMSException
- if an error is encountered when trying to set.SSOException
- if the single sign on token is invalid or expiredpublic java.lang.String[] getChoiceValues()
SINGLE_CHOICE
or MULTIPLE_CHOICE
.public java.lang.String[] getChoiceValues(java.util.Map envParams)
SINGLE_CHOICE
or MULTIPLE_CHOICE
, for the given environment
parameters.envParams
- Map of environment parameter to a set of valuespublic java.lang.String getChoiceValueI18NKey(java.lang.String cValue)
cValue
- choice value.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
- if an error is encountered when trying to set.SSOException
- if the single sign on token is invalid or expiredpublic void removeChoiceValue(java.lang.String value) throws SMSException, SSOException
value
- the choice value to removeSMSException
- if an error is encountered when trying to set.SSOException
- if the single sign on token is invalid or expiredpublic java.lang.String getStartRange()
NUMBER_RANGE
or DECIMAL_RANGE
.public void setStartRange(java.lang.String stRange) throws SMSException, SSOException
stRange
- start range.SMSException
- if an error is encountered when trying to setSSOException
- if the single sign on token is invalid or expiredpublic java.lang.String getEndRange()
NUMBER_RANGE
or DECIMAL_RANGE
.public void setEndRange(java.lang.String edRange) throws SMSException, SSOException
edRange
- end range.SMSException
- if an error is encountered when trying to setSSOException
- if the single sign on token is invalid or expiredpublic java.lang.String getValidator()
public void setValidator(java.lang.String valid) throws SMSException, SSOException
valid
- validatorSMSException
- if an error is encountered when trying to setSSOException
- if the single sign on token is invalid or expiredpublic int getMinValue()
MULTIPLE_CHOICE
.public void setMinValue(java.lang.String minV) throws SMSException, SSOException
minV
- minimum value.SMSException
- if an error is encountered when trying to setSSOException
- if the single sign on token is invalid or expiredpublic int getMaxValue()
MULTIPLE_CHOICE
.public void setMaxValue(java.lang.String maxV) throws SMSException, SSOException
maxV
- maximum value.SMSException
- if an error is encountered when trying to setSSOException
- if the single sign on token is invalid or expiredpublic java.lang.String getTrueValue()
BooleanTrueValue
.BooleanTrueValue
.public java.lang.String getTrueValueI18NKey()
I18N
key for BooleanTrueValue
.I18N
key for BooleanTrueValue
.public java.lang.String getFalseValue()
BooleanFalseValue
.BooleanFalseValue
.public java.lang.String getFalseValueI18NKey()
I18N
Key for BooleanFalseValue
.I18N
Key for BooleanFalseValue
.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
a
- value for any attribute.SMSException
- if an error is encountered when trying to set.SSOException
- if the single sign on token is invalid or expired.public java.lang.String getPropertiesViewBeanURL()
public void setPropertiesViewBeanUR(java.lang.String prop) throws SMSException, SSOException
prop
- properties view bean URL.SMSException
- if an error is encountered when trying to set.SSOException
- if the single sign on token is invalid or expired.public boolean isSearchable()
true
if the attribute is searchable;
false
otherwisetrue
if the attribute is an optional attribute;
false
otherwisepublic void setSearchable(java.lang.String value) throws SMSException, SSOException
true
, or false
.value
- if set to true
the attribute will
be searchable;
else searches cannot be performed on this attribute.SMSException
- if an error is encountered when trying to
setSSOException
- if the single sign on token is invalid or expiredpublic java.lang.String toString()
AttributeSchema
object.toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |