Oracle Fusion Middleware
Workflow Services Java API Reference for Oracle SOA Suite
11g Release 1 (11.1.1.7)
E10660-11

oracle.tip.pc.services.identity
Interface BPMPrincipal

All Superinterfaces:
java.security.Principal
All Known Subinterfaces:
BPMAppRole, BPMGroup, BPMIdentity, BPMRole, BPMUser

public interface BPMPrincipal
extends java.security.Principal

BPMPrincipal represents Identity


Method Summary
 java.lang.Object getAttribute(java.lang.String attrName)
          Gets object attribute by attribute name.
 java.util.Map getAttributes()
          Get all object attributes
 java.lang.String getDescription()
          Gets ProcessConnect principal description
 java.lang.String getDisplayName()
          Gets ProcessConnect display name
 java.lang.String getDisplayName(java.util.Locale locale)
          Get display name of the the principal in given locale.
 java.lang.String getFullName()
          Deprecated. since 11.1.1.
 java.lang.String getGuid()
          Gets principal guid.
 java.lang.String getRealmName()
          Gets realm name
 java.lang.String getUniqueName()
          Gets unique principal name.
 org.w3c.dom.Node toNode()
          Create a DOM Node from the object
 
Methods inherited from interface java.security.Principal
equals, getName, hashCode, toString
 

Method Detail

getRealmName

java.lang.String getRealmName()
                              throws BPMIdentityException
Gets realm name

Returns:
realm name
Throws:
BPMIdentityException

getDisplayName

java.lang.String getDisplayName()
                                throws BPMIdentityException
Gets ProcessConnect display name

Returns:
display name of this BPMPrincipal
Throws:
BPMIdentityException

getDescription

java.lang.String getDescription()
                                throws BPMIdentityException
Gets ProcessConnect principal description

Returns:
discription of this BPMprincipal
Throws:
BPMIdentityException

getFullName

java.lang.String getFullName()
                             throws BPMIdentityException
Deprecated. since 11.1.1.

Gets full principal name.

Returns:
a full principal name in given realm
Throws:
BPMIdentityException

getUniqueName

java.lang.String getUniqueName()
                               throws BPMIdentityException
Gets unique principal name.

Returns:
a name principal name
Throws:
BPMIdentityException

getGuid

java.lang.String getGuid()
                         throws BPMIdentityException
Gets principal guid.

Returns:
guid
Throws:
BPMIdentityException

getAttribute

java.lang.Object getAttribute(java.lang.String attrName)
                              throws BPMIdentityException
Gets object attribute by attribute name. It returns either String , byte[], List of Strings or byte[] or null

Parameters:
attrName - a attribute name
Returns:
object or null, if attribute is not found
Throws:
BPMIdentityException

getAttributes

java.util.Map getAttributes()
Get all object attributes

Returns:
map of all attributes

toNode

org.w3c.dom.Node toNode()
                        throws BPMIdentityException
Create a DOM Node from the object

Returns:
Node DOM Node representing the BPMPrintipal object
Throws:
BPMIdentityException

getDisplayName

java.lang.String getDisplayName(java.util.Locale locale)
Get display name of the the principal in given locale. f Locale is not specified, default locale is used.

Parameters:
locale -
Returns:
Display name of the principal in specified locale. I

Oracle Fusion Middleware
Workflow Services Java API Reference for Oracle SOA Suite
11g Release 1 (11.1.1.7)
E10660-11

Copyright © 2009, 2013, Oracle and/or its affiliates. All rights reserved.