|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AMTemplate
Represents a service template associated with a AMObject. Sun Java System Access Manager distinguishes between virtual and entry attibutes. Per iDS terminology, virtual attribute is an attribute that is not physically stored in an LDAP entry but still returned with the LDAP entry as a result of a LDAP search operation. Virtual attributes are analagous to the "inherited" attributes. Entry attributes are non-inherited attributes. For each AMObject, virtual attributes can be grouped in a Template on a per-service basis. Hence, there may be one service Template per service for any given AMObject. A given object may have more than one Template, in total, one each for each of the services for that object. Such templates determine the service attributes inherited by all the other objects within the scope of this object.
When any object inherits more than one template for the same service (by virtue of being in the scope of two or more objects with service templates), conflicts between such templates are resolved by the use of template priorities. In this priority scheme, zero is the highest possible priority with the lower priorities extending towards finity. Templates with higher priorities will be favored over and to the exclusion of templates with lower priorities. Templates which do not have an explicitly assigned priority are considered to have the lowest priority possible, or no priority. In the case where two or more templates are being considered for inheritance of an attribute value, and they have the same (or no) priority, the result is undefined, but does not exclude the possibility that a value will be returned, however arbitrarily chosen.
The two types of templates supported in Identity Management are: Organization templates and Dynamic templates. Organizatin templates manage service attributes of services that are registered to an organization, while dynamic templates manage service attributes for both organizations and roles.
Note: Policy templates are no longer supported by AM SDK. Use
com.sun.identity.policy
package to manage policy attributes.
Code sample on how to obtain service templates from AMOrganization object: AMTemplate orgTemplate; if (org.orgTemplateExists("iPlanetAMAuthService") { orgTemplate = org.getTemplate("iPlanetAMAuthService", AMTemplate.ORGANIZATION_TEMPLATE); Map attributes = orgTemplate.getAttributes(); - more code here - } AMTemplate dynTemplate = org.getTemplate("iPlanetAMSessionService", AMTemplates.DYNAMIC_TEMPLATE); if (dynTemplate.isExists()) { Map attributes = dynTemplate.getAttributes(); - more code here - }
Field Summary | |
---|---|
static int |
ALL_TEMPLATES
Deprecated. Represents both dynamic and policy template for a service |
static int |
DYNAMIC_TEMPLATE
Deprecated. Represents the Dynamic template type |
static int |
ORGANIZATION_TEMPLATE
Deprecated. Represents an Organization template type |
static int |
POLICY_TEMPLATE
Deprecated. Represents a Policy template type |
static int |
UNDEFINED_PRIORITY
Deprecated. Represents the priority of a template whose priority is not explicitly set. |
Fields inherited from interface com.iplanet.am.sdk.AMObject |
---|
ACTIVE, ACTIVE_VALUE, ASSIGNABLE_DYNAMIC_GROUP, DELETED, DELETED_VALUE, DYNAMIC_GROUP, FILTERED_ROLE, GROUP, GROUP_CONTAINER, GROUP_PROFILE, INACTIVE, INACTIVE_VALUE, MANAGED_ROLE, ORGANIZATION, ORGANIZATIONAL_UNIT, PEOPLE_CONTAINER, POLICY, RESOURCE, ROLE, ROLE_PROFILE, SERVICE, STATIC_GROUP, TEMPLATE, UNDETERMINED_OBJECT_TYPE, UNKNOWN_OBJECT_TYPE, USER |
Method Summary | |
---|---|
Set |
getAttributeSchemas()
Deprecated. Returns a set of Attribute Schemas that defines the schema (metadata) of this template. |
Set |
getPolicyNames()
Deprecated. Returns a set of policy distinguished names if this AMTemplate is a named policy template, otherwise returns
null. |
int |
getPriority()
Deprecated. Returns the priority of this template in the DIT. |
String |
getServiceName()
Deprecated. Gets the name of the service to which this template belongs. |
int |
getType()
Deprecated. Gets the type of the template. |
void |
setPriority(int priority)
Deprecated. Sets the priority of this template in the DIT |
Field Detail |
---|
static final int POLICY_TEMPLATE
static final int DYNAMIC_TEMPLATE
static final int ORGANIZATION_TEMPLATE
static final int ALL_TEMPLATES
static final int UNDEFINED_PRIORITY
Method Detail |
---|
String getServiceName()
AttributeSchema/ServiceSchema
for the service.
Set getAttributeSchemas() throws AMException, SSOException
com.sun.identity.sm.AttributeSchema
for
this template.
AMException
- if an error is encountered when trying to access/retrieve
data from the data store.
SSOException
- if the single sign on token is no longer valid.int getPriority() throws SSOException
SSOException
- if the single sign on token is no longer valid.void setPriority(int priority) throws AMException, SSOException
priority
- priority
AMException
- if an error is encountered when trying to access/retrieve
data from the data store.
SSOException
- if the single sign on token is no longer valid.int getType()
Set getPolicyNames() throws AMException, SSOException
AMTemplate
is a named policy template, otherwise returns
null.
AMException
- if an error is encountered when trying to access/retrieve
data from the data store.
SSOException
- if the single sign on token is no longer valid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |