Skip navigation links

oracle.iam.platform.authopss.vo
Class EntityPublication

java.lang.Object
oracle.iam.platform.authopss.vo.EntityPublication

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AdminRolePublication, AppInstancePublication, EntitlementPublication, RolePublication

public class EntityPublication

extends java.lang.Object

implements java.io.Serializable

This class represents a scope in which an entity is published. An entity can be published in more than one scope. Use EntityPublicationManager to collate all publication of an entity. You can create an in-memory instance of this class and pass it to EntityPublicationManager to persist it. The logged-in user at the time should have appropriate privileges to perform operation. Persisted publications are used internally to make authorization decisions.

Since:

OIM R2 (11.1.2.0.0)

See Also:

Serialized Form

Nested Class Summary

static class

EntityPublication.Attribute Enum that represents the sort fields (passed with control param).

Constructor Summary

EntityPublication()
Default constructor.

EntityPublication(java.lang.String entityId, PolicyConstants.Resources entityType, java.lang.Long scopeId, boolean hierarchicalScope)
Alternate constructor that takes the values of scopeId correctly as Long.

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getEntityId() Getter for the the entity-id.
java.lang.Long	getEntityPublicationId() Returns the unique publication-id associated with this publication object.
java.lang.String	getEntityType() Getter for the entity-type represented by this publication object.
java.lang.String	getRootScopeId() .
java.lang.String	getRootScopeName() API to get the root scope name (name of organization where this publication is directly published).
java.lang.String	getScopeId() Getter for the scope(organization)-id for this publication.
java.lang.String	getScopeName() Returns the organization name of the scope that this publication represents
java.lang.String	getScopeType() The type of the oraganization/scope.
int	hashCode()
boolean	isHierarchicalScope() Getter for the hierarchy flag.
void	setEntityId(java.lang.String entityId) Method to set the the entity-id of the object(Role/app-instance/Entitlement) that this publication represents.
void	setEntityPublicationId(java.lang.Long entityPublicationId) Sets the unique publication-id for this publication.
void	setEntityType(java.lang.String entityType) The entity-type for this publication.
void	setHierarchicalScope(boolean hierarchicalScope) The flag to represent whether this publication is available to all the child organizations where this publication is directly published.
void	setScopeId(java.lang.String scopeId) Setter for the organization-id for this publication.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EntityPublication

public EntityPublication()

Default constructor. Required by eclipselink. For all cases parametrized constructor should be used.

EntityPublication

public EntityPublication(java.lang.String entityId,
                         PolicyConstants.Resources entityType,
                         java.lang.Long scopeId,
                         boolean hierarchicalScope)

Alternate constructor that takes the values of scopeId correctly as Long.

Parameters:

entityId -

entityType -

scopeId -

hierarchicalScope -

Method Detail

setEntityPublicationId

public void setEntityPublicationId(java.lang.Long entityPublicationId)

Sets the unique publication-id for this publication. While persisting publications, publication-id should be left null.

Parameters:

entityPublicationId -

getEntityPublicationId

public java.lang.Long getEntityPublicationId()

Returns the unique publication-id associated with this publication object.

Returns:

setEntityId

public final void setEntityId(java.lang.String entityId)

Method to set the the entity-id of the object(Role/app-instance/Entitlement) that this publication represents. This is mandatory attribute while creating/modifying a publication.

Parameters:

entityId -

getEntityId

public final java.lang.String getEntityId()

Getter for the the entity-id.

Returns:

setEntityType

public final void setEntityType(java.lang.String entityType)

The entity-type for this publication. Valid values are: 1. Role 2. ApplicationInstance 3. Entitlement This is mandatory attribute while creating/modifying a publication.

Parameters:

entityType - - The entity type.

getEntityType

public final java.lang.String getEntityType()

Getter for the entity-type represented by this publication object.

Returns:

The entity type for this publication

setScopeId

public final void setScopeId(java.lang.String scopeId)

Setter for the organization-id for this publication. The scope along with hierarchy flag will determine the organizations where the publication will be available. This is mandatory attribute while creating/modifying a publication.

Parameters:

scopeId- - The organization-id that this publication represents.

getScopeId

public final java.lang.String getScopeId()

Getter for the scope(organization)-id for this publication.

Returns:

setHierarchicalScope

public final void setHierarchicalScope(boolean hierarchicalScope)

The flag to represent whether this publication is available to all the child organizations where this publication is directly published.

Parameters:

hierarchicalScope -

isHierarchicalScope

public final boolean isHierarchicalScope()

Getter for the hierarchy flag.

Returns:

getRootScopeId

public final java.lang.String getRootScopeId()

. * @return the rootScopeId

getScopeName

public final java.lang.String getScopeName()

Returns the organization name of the scope that this publication represents

Returns:

the scopeName

getScopeType

public final java.lang.String getScopeType()

The type of the oraganization/scope.

Returns:

the scopeType

getRootScopeName

public final java.lang.String getRootScopeName()

API to get the root scope name (name of organization where this publication is directly published).

Returns:

- name of organization where this publication is directly published

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

Skip navigation links