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 three special principal types as string constants: #AUTHENTICATED-USERS, #CREATOR-OWNER and #REALM-USERS(qualifier). 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. Note that users that were found in a DirectoryConfiguration that had its ExcludeFromAU property set true will not be a member of #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.

    The #REALM-USERS(qualifier) principal is a pseudo-group whose members are all users that were found in the Realm specified by qualifier, which may be either that Realm's SymbolicName or its Id string.

    See Also:
    Serialized Form

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method and Description
      static SpecialPrincipal getInstanceFromString(java.lang.String value)
      Deprecated. 
      As of P8 5.2.2, and will be removed in a later release.
      java.lang.String getValue()
      Returns a String associated with a specific instance of this class.
      static boolean isAuthenticatedUsers(java.lang.String principal)
      Return whether or not this principal is the special #AUTHENTICATED-USERS pseudo-group.
      static boolean isCreatorOwner(java.lang.String principal)
      Return whether or not this principal is the special #CREATOR-OWNER pseudo-user.
      static boolean isRealmUsers(java.lang.String principal)
      Return whether or not this principal is the special #REALM-USERS(realmNameOrId) pseudo-group.
      static java.lang.String parseRealmUsers(java.lang.String principal)
      Return the realm name or ID string part of a #REALM-USERS principal or null if this is not a syntactically correct #REALM-USERS principal (the name or ID part is not checked for validity).
      static SpecialPrincipal REALM_USERS(Realm realm)
      Return a SpecialPrincipal object for a #REALM-USERS(realm)
      static SpecialPrincipal REALM_USERS(java.lang.String qualifier)
      Return a SpecialPrincipal object for a #REALM-USERS(qualifier)
      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)
        Deprecated. As of P8 5.2.2, and will be removed in a later release.
        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, CREATOR_OWNER and REALM_USERS; additionally REALM_USERS may have an optional appended (domain id). The value cannot be null.
        Returns:
        A SpecialPrincipal object of the type requested or null if this doesn't appear to be a special '#' principal.
        Throws:
        EngineRuntimeException - if the input parameter is invalid or null.

      • REALM_USERS

        public static SpecialPrincipal REALM_USERS(java.lang.String qualifier)
        Return a SpecialPrincipal object for a #REALM-USERS(qualifier)
        Parameters:
        qualifier - either a Realm's SymbolicName or its Id in string form.
        Returns:
        a SpecialPrincipal representing the #REALM-USERS special principal for the given realm

      • REALM_USERS

        public static SpecialPrincipal REALM_USERS(Realm realm)
        Return a SpecialPrincipal object for a #REALM-USERS(realm)
        Parameters:
        realm - the Realm object to be used for this #REALM-USERS principal
        Returns:
        a SpecialPrincipal representing the #REALM-USERS special principal for the given realm

      • isAuthenticatedUsers

        public static boolean isAuthenticatedUsers(java.lang.String principal)
        Return whether or not this principal is the special #AUTHENTICATED-USERS pseudo-group.
        Parameters:
        principal - the principal string to test
        Returns:
        true if this principal is the special #AUTHENTICATED-USERS pseudo-group or false otherwise.

      • isCreatorOwner

        public static boolean isCreatorOwner(java.lang.String principal)
        Return whether or not this principal is the special #CREATOR-OWNER pseudo-user.
        Parameters:
        principal - the principal string to test
        Returns:
        true if this principal is the special #CREATOR-OWNER pseudo-user or false otherwise.

      • isRealmUsers

        public static boolean isRealmUsers(java.lang.String principal)
        Return whether or not this principal is the special #REALM-USERS(realmNameOrId) pseudo-group.
        Parameters:
        principal - the principal string to test
        Returns:
        true if this principal is the special #REALM-USERS(realmNameOrId) pseudo-group or false otherwise.

      • parseRealmUsers

        public static java.lang.String parseRealmUsers(java.lang.String principal)
        Return the realm name or ID string part of a #REALM-USERS principal or null if this is not a syntactically correct #REALM-USERS principal (the name or ID part is not checked for validity).
        Parameters:
        principal - the principal name, which should be in the form of "#REALM-USERS(realmNameOrId)".
        Returns:
        the given realm symbolic name or ID string of the given #REALM-USERS principal. If this does not appear to be a valid #REALM-USERS, null will be returned.

      • 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.
Skip navigation links

© Copyright IBM Corporation 2006, 2019. All rights reserved.