com.ibm.itim.dataservices.model.pim
Class SAEntitlement

java.lang.Object
  com.ibm.itim.dataservices.model.pim.SAEntitlement

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

SAEntitlementCredentialObject, SAEntitlementCriteria

public abstract class SAEntitlement
extends java.lang.Object
implements java.io.Serializable

This class represents an entitlement of the shared access policy. An entitlement is defined by a type (credential, credential pool), a definition type (criteria, specific credential object), and a set of criteria, or a target representing the DN string of the credential or credential pool.

Since:

6.0

See Also:

SharedAccessPolicy, SAEntitlementCriteria, SAEntitlementCredentialObject, Serialized Form

Nested Class Summary

static class	SAEntitlement.DefinitionType Enumeration of entitlement definition type
static class	SAEntitlement.Type Enumeration of entitlement type

Field Summary

static long

ID_NOT_ASSIGNED Constant indicating the entitlement ID is not assigned yet, which means the entitlement does not exsit in the repository.

Constructor Summary

SAEntitlement()
The default constructor.

Method Summary

SAEntitlement.DefinitionType	getDefinitionType() This API returns the entitlement definition type, which can be DefinitionType.CREDENTIAL_OBJECT, or DefinitionType.CRITERIA.
long	getId() Return the entitlement unique identifier.
java.lang.String	getName() This API returns the entitlement name.
java.lang.String	getServiceName() This API returns the service name or its matching string.
java.lang.String	getServiceProfileName() This API returns the service profile name.
java.lang.String	getServiceTag() This API returns the service tag or its matching string defined in shared access policy criteria type entitlement.
java.lang.String	getTargetName() This API returns the target name.
SAEntitlement.Type	getType() This API returns the entitlement type, which can be Type.CREDENTIAL, or Type.CREDENTIAL_POOL.
void	setType(SAEntitlement.Type type) This API sets the entitlement type, which can be Type.CREDENTIAL, or Type.CREDENTIAL_POOL.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID_NOT_ASSIGNED

public static final long ID_NOT_ASSIGNED

Constant indicating the entitlement ID is not assigned yet, which means the entitlement does not exsit in the repository.

See Also:

Constant Field Values

Constructor Detail

SAEntitlement

public SAEntitlement()

The default constructor.

Method Detail

getId

public long getId()

Return the entitlement unique identifier.

Returns:

the entitlement id.

getName

public java.lang.String getName()

This API returns the entitlement name.

Returns:

String represents the entitlement's user friendly name.

getType

public SAEntitlement.Type getType()

This API returns the entitlement type, which can be Type.CREDENTIAL, or Type.CREDENTIAL_POOL.

Returns:

the enumerated Type value.

getDefinitionType

public SAEntitlement.DefinitionType getDefinitionType()

This API returns the entitlement definition type, which can be DefinitionType.CREDENTIAL_OBJECT, or DefinitionType.CRITERIA.

Returns:

the enumerated DefinitionType value.

getTargetName

public java.lang.String getTargetName()

This API returns the target name.

For entitlement with a specific credential or credential pool, it represents the account user id or pool name.

For entitlement with criteria definition, it represents the matching string for the account user id or pool name.

Returns:

the target name.

getServiceProfileName

public java.lang.String getServiceProfileName()

This API returns the service profile name.

Returns:

the service profile name. Return empty string if this entitlement is for all services.

getServiceName

public java.lang.String getServiceName()

This API returns the service name or its matching string.

For entitlement with a specific credential or credential pool, it represents the service name.

For entitlement with criteria definition, it represents the matching string for the service name.

Returns:

the service name.

getServiceTag

public java.lang.String getServiceTag()

This API returns the service tag or its matching string defined in shared access policy criteria type entitlement. The service tag is a tagging attribute on services for grouping purpose.

Returns:

the service tag match string.
For entitlements with specific credentials or credential pools, the service tag is irrelevant.
For entitlements with criteria definition, it represents the matching string to search for services using tag.

setType

public void setType(SAEntitlement.Type type)

This API sets the entitlement type, which can be Type.CREDENTIAL, or Type.CREDENTIAL_POOL.

Parameters:

type - The enumerated Type value.