| com.sun.portal.fabric.common.AttributeHandler
All known Subclasses: com.sun.portal.sra.admin.attribute.handlers.GatewayAttributeHandler, com.sun.portal.fabric.common.GenericDSAMEAttributeHandler, com.sun.portal.sra.admin.attribute.handlers.BaseSraAttributeHandler,
| AttributeHandler | | public interface AttributeHandler (Code) | | This interface needs to be implementing by all component specific
attribute handlers.
|
| Method Summary | |
| List | getAttribute(Map optionsMap)
| | String | getAttributeName(String userFriendlyName)
Maps the user friendly name of the attribute to its real name. | | Map | getAttributes(Map optionsMap)
| | String | getComponentName(String userFriendlyName)
Maps the user friendly name of the component to its real name. | | void | init(String component, String domainId, String portalId)
| | Map | listAttributes(Map optionsMap)
Returns a map where the key is the user friendly name of the
attribute and the value is a list.
The list consists of the following in this order:
- type as defined in AttributeInfo (mandatory)
- i18n key for description like range of values etc.
| | void | setAttribute(List values, Map optionsMap)
| | void | setAttributes(Map nameValues, Map optionsMap)
Sets the value(s) for multiple attributes passed in the map
This method does not support add/remove/inherit. | | void | validate(List values, Map optionsMap)
Performs validation of the options in the map
This method supports validating values only for singular set
operation. |
| getAttribute | | List getAttribute(Map optionsMap) throws PSMBeanException(Code) | | Returns a list of values for the attribute name passed in the map
The optionsMap contains these in addition to component
specific options
operation = get
//common basic options
OPT_COMPONENT = "component";
OPT_ATTR_NAME = "attribute-name";
OPT_DN = "dn";
OPT_GLOBAL = "global";
OPT_ORG = "org";
//set operation options
OPT_INHERIT = "inherit";
OPT_ADD = "add";
OPT_REMOVE = "remove";
Parameters:
optionsMap - a map containing key-value pairs for options list of values for the attribute
throws:
PSMBeanException - if there was error in retrieving the value |
| getAttributeName | | String getAttributeName(String userFriendlyName)(Code) | | Maps the user friendly name of the attribute to its real name.
Parameters:
userFriendlyName - string passed in a name of the attribute real name of the attribute in backend or null if such attributedoes not exist |
| getAttributes | | Map getAttributes(Map optionsMap) throws PSMBeanException(Code) | | Returns attributes at the specific dn or at top level
If global, then dn should not be specified
If org and dn is not specified, then its org default
If neither global nor org, then its dynamic
If neither global nor org and no dn, then its dynamic default
If neither global nor org and dn is user dn, then its user attrs
The optionsMap contains these in addition to component
specific options
operation = get
//common basic options
OPT_COMPONENT = "component";
OPT_ATTR_NAMES = "attribute-names"
OPT_DN = "dn";
OPT_GLOBAL = "global";
OPT_ORG = "org";
OPT_ATTR_NAMES should be a String Set of friendly attr names
The returned Map contains these attr names as keys and the values are
List objects
Parameters:
optionsMap - a map containing key-value pairs for options map of name-ListValues for the attribute
throws:
PSMBeanException - if there was error in retrieving the value |
| getComponentName | | String getComponentName(String userFriendlyName)(Code) | | Maps the user friendly name of the component to its real name.
Parameters:
userFriendlyName - string passed in a name of the component real name of the component in backend such as the service name |
| init | | void init(String component, String domainId, String portalId) throws PSMBeanException(Code) | | Initializes the handler
Parameters:
component - string representing the user friendly component name
Parameters:
domainId - string representing the portal domain
Parameters:
portalId - string representing the identifier for portal
throws:
PSMBeanException - if there was error in initilization |
| listAttributes | | Map listAttributes(Map optionsMap) throws PSMBeanException(Code) | | Returns a map where the key is the user friendly name of the
attribute and the value is a list.
The list consists of the following in this order:
- type as defined in AttributeInfo (mandatory)
- i18n key for description like range of values etc. (optional)
- r/w/ro/wo privilege (optional, default is r/w) as defined in AttributeInfo
- i18n key for example (optional)
The list is always in this order and if some info is not applicable
then a null is specified for it. For example, if there is no
descrition but privilege is specified, then a null
in inserted for description. If only type is specified, then the
list size may be "1".
Parameters:
optionsMap - a map containing key-value pairs for options map containing attribute-name and information about it
throws:
PSMBeanException - if the there was an error |
| setAttribute | | void setAttribute(List values, Map optionsMap) throws PSMBeanException(Code) | | Sets the value(s) for the attribute name passed in the map
The optionsMap contains these in addition to component
specific options
operation = set
//common basic options
OPT_COMPONENT = "component";
OPT_ATTR_NAME = "attribute-name";
OPT_DN = "dn";
OPT_GLOBAL = "global";
OPT_ORG = "org";
//set operation options
OPT_INHERIT = "inherit";
OPT_ADD = "add";
OPT_REMOVE = "remove";
OPT_COMPONENT is the friendly service name
OPT_ATTR_NAME is the friendly attr name
Parameters:
values - list of values to be set for the component
Parameters:
optionsMap - a map containing key-value pairs for options
throws:
PSMBeanException - if there was an error in setting the value |
| setAttributes | | void setAttributes(Map nameValues, Map optionsMap) throws PSMBeanException(Code) | | Sets the value(s) for multiple attributes passed in the map
This method does not support add/remove/inherit. It is only
to set the values.
The optionsMap contains these in addition to component
specific options
operation = set
//common basic options
OPT_COMPONENT = "component";
OPT_DN = "dn";
OPT_GLOBAL = "global";
OPT_ORG = "org";
OPT_COMPONENT is the friendly service name
The nameValues map consists of mapping between friendly attr name
and its value which is a List
Parameters:
nameValues - map of name-ListValues of attrs
Parameters:
optionsMap - a map containing key-value pairs for options
throws:
PSMBeanException - if there was an error in setting the value |
| validate | | void validate(List values, Map optionsMap) throws PSMBeanException(Code) | | Performs validation of the options in the map
This method supports validating values only for singular set
operation. For setting values for multiple attrs, pass in null
for values and do validation before actually setting the specific
attr in the attr set.
throws:
PSMBeanException - if the validation failed |
|
|