Skip navigation links

Oracle BPEL Process Manager
Workflow Services API Reference
10g Release 3 (10.1.3)
B28985-02


oracle.bpel.services.workflow.verification
Interface IWorkflowContext

All Superinterfaces:
java.io.Serializable

public interface IWorkflowContext
extends java.io.Serializable

IWorkflowContext is the public interface for a Workflow Context object. It is usually created on behalf of a user after verifying the credentials with the identity authentication service. It can also be created on behalf of a process or business application for a specific task object. The Workflow Context contains the security token and other information associated with the user [such as locale, timezone etc.] / object [id]. Every operation performed on the Workflow Service requires a user's credential or a security token that denotes a Workflow Context


Method Summary
 java.lang.String getIdentityContext()
          getIdentityContext returns the identity context (typically realm) of the connected user
 boolean getIsAdmin()
          getIsAdmin returns a boolean denoting admin privilege of connected user
 java.util.Locale getLocale()
          getLocale returns the user's Locale
 java.lang.String getObjectId()
          getObjectId returns the objectId that the context is associated with.
 long getStartDateTime()
          Gets the time the context is created
 java.util.TimeZone getTimeZone()
          getTimeZone returns the user's TimeZone
 java.lang.String getToken()
          getToken returns the token if the user is authenticated
 java.lang.String getUser()
          getUser returns the user name of the connected user

 

Method Detail

getUser

public java.lang.String getUser()
getUser returns the user name of the connected user
Returns:
String The user name of the connected user

getIdentityContext

public java.lang.String getIdentityContext()
getIdentityContext returns the identity context (typically realm) of the connected user
Returns:
String The identity context of the connected user

getToken

public java.lang.String getToken()
getToken returns the token if the user is authenticated
Returns:
String The token if the user is authenticated

getObjectId

public java.lang.String getObjectId()
getObjectId returns the objectId that the context is associated with. It returns a non null value only if the context has a valid association
Returns:
String The objectId the context is associated with

getIsAdmin

public boolean getIsAdmin()
getIsAdmin returns a boolean denoting admin privilege of connected user
Returns:
boolean true if the user has admin previleges, false otherwise

getLocale

public java.util.Locale getLocale()
getLocale returns the user's Locale
Returns:
Locale The user's locale

getTimeZone

public java.util.TimeZone getTimeZone()
getTimeZone returns the user's TimeZone
Returns:
TimeZone The user's time zone

getStartDateTime

public long getStartDateTime()
Gets the time the context is created
Returns:
long The time the context was created

Skip navigation links

Oracle BPEL Process Manager
Workflow Services API Reference
10g Release 3 (10.1.3)
B28985-02


Copyright © 2006, Oracle. All rights reserved.