com.filenet.api.constants

Class SpecialPrincipal

java.lang.Object

com.filenet.api.constants.SpecialPrincipal

All Implemented Interfaces:

java.io.Serializable

public class SpecialPrincipal
extends java.lang.Object
implements java.io.Serializable

Exposes two special principal types as string constants: #AUTHENTICATED-USERS and #CREATOR-OWNER. These principal types are not real directory service entities; they represent special pseudo-accounts.

The #AUTHENTICATED-USERS pseudo-account is a logical group, all of whose members are authenticated users.

The #CREATOR-OWNER principal is the pseudo-account granted to the user who creates an object. It is a placeholder for the future owner of an object. A specific set of permissions (ACL) is defined for this account. These permissions provide full control over the created object. When the ACL is actually used, the real identity of the user accessing the object is substituted and becomes the actual owner ID. This occurs in the following instances:

• When security templates are applied.
• When an object inherits security from a parent.
• When a security descriptor is initialized from the class's default instance security. An exception to this rule is when the object's DefaultInstanceOwner property is set to null, in which case permissions from the default instance security that specify #CREATOR-OWNER as the grantee are ignored and not copied to the Permissions collection of the created object.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static SpecialPrincipal	AUTHENTICATED_USERS Specifies a SpecialPrincipal that is a group of authenticated users.
static SpecialPrincipal	CREATOR_OWNER Specifies a SpecialPrincipal that is the #CREATOR-OWNER account.

Method Summary

Methods

Modifier and Type	Method and Description
static SpecialPrincipal	getInstanceFromString(java.lang.String value) Returns an instance of this class based on the specified value.
java.lang.String	getValue() Returns a String associated with a specific instance of this class.
java.lang.String	toString() Returns a String representation of this SpecialPrincipal instance.

Methods inherited from class java.lang.Object

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

Field Detail

AUTHENTICATED_USERS

public static final SpecialPrincipal AUTHENTICATED_USERS

Specifies a SpecialPrincipal that is a group of authenticated users.

Note: Specifying that #AUTHENTICATED-USERS be the default user/group of an object store would permit all users who successfully logon to the FileNet P8 domain to access that object store.

CREATOR_OWNER

public static final SpecialPrincipal CREATOR_OWNER

Specifies a SpecialPrincipal that is the #CREATOR-OWNER account.

Method Detail

getValue

public java.lang.String getValue()

Returns a String associated with a specific instance of this class. The value will be either AUTHENTICATED_USERS or CREATOR_OWNER.

Returns:

A String representing a specific instance of this class.

getInstanceFromString

public static SpecialPrincipal getInstanceFromString(java.lang.String value)

Returns an instance of this class based on the specified value.

Parameters:

value - A String representing the SpecialPrincipal to retrieve. Valid values are AUTHENTICATED_USERS and CREATOR_OWNER; cannot be null.

Returns:

A SpecialPrincipal object of the type requested.

Throws:

EngineRuntimeException - if the input parameter is invalid or null.

toString

public java.lang.String toString()

Returns a String representation of this SpecialPrincipal instance.

Overrides:

toString in class java.lang.Object

Returns:

A String representing this SpecialPrincipal.