com.bea.b2b.wlpi
Class WorkflowEnablerSessionManager

java.lang.Object
  |
  +--com.bea.b2b.wlpi.WorkflowEnablerSessionManager

public class WorkflowEnablerSessionManager
extends java.lang.Object

The WorflowEnablerSessionManager class controls workflow c-enabler sessions.

Author:
Copyright © 2000 BEA Systems, Inc. All Rights Reserved.

Method Summary
static WorkflowEnablerSessionManager get()
          Gets the only workflow c-enabler session manager.
 WorkflowEnablerSession getEnablerSession(java.lang.String configFile, java.lang.String sessionName, java.lang.String orgName)
          Creates a workflow c-enabler session with the specified c-enabler XML configuration file, session name, and organization name.
 WorkflowEnablerSession getEnablerSession(java.lang.String configFile, java.lang.String sessionName, java.lang.String orgName, java.lang.String user, java.lang.String password)
          Creates a workflow c-enabler session with the specified c-enabler XML configuration file, session name, organization name, username and password.
 WorkflowEnablerSession getExistingEnablerSession(java.lang.String sessionName)
          Gets an existing workflow c-enabler session with the specified session name.
 boolean isEnablerAvailable(java.lang.String sessionName, java.lang.String userName, java.lang.String org)
          Determines whether the specified c-enabler session is available (true) or not (false).
 void startEnabler(java.lang.String sessionName, java.lang.String userName, java.lang.String org)
          Starts the specified c-enabler session.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

get

public static WorkflowEnablerSessionManager get()
Gets the only workflow c-enabler session manager.

Returns:
theManager - Workflow c-enabler session manager.

isEnablerAvailable

public boolean isEnablerAvailable(java.lang.String sessionName,
                                  java.lang.String userName,
                                  java.lang.String org)
Determines whether the specified c-enabler session is available (true) or not (false). A c-enabler session might not be available if it was configured but not started due to the lack of any available active templates.

Parameters:
sessionName - Name of the c-enabler session.
userName - Name of the user for the workflow template.
org - WebLogic Process Integrator organization associated with the user.
Returns:
boolean true if the specified c-enabler session is available, or false if not.

startEnabler

public void startEnabler(java.lang.String sessionName,
                         java.lang.String userName,
                         java.lang.String org)
                  throws WLPIException,
                         WLPINoActiveTemplateException
Starts the specified c-enabler session. Call this method to start a c-enabler session that was configured at bootup but not started due to the lack of any available active templates.

Parameters:
sessionName - Name of the c-enabler session.
userName - Name of the user for the workflow template.
org - WebLogic Process Integrator organization associated with the user.

getEnablerSession

public WorkflowEnablerSession getEnablerSession(java.lang.String configFile,
                                                java.lang.String sessionName,
                                                java.lang.String orgName)
                                         throws WLPIException,
                                                WLPINoActiveTemplateException
Creates a workflow c-enabler session with the specified c-enabler XML configuration file, session name, and organization name.

Parameters:
configFile - C-enabler XML configuration file.
sessionName - Name of the c-enabler session.
orgName - Name of the WebLogic Process Integrator organization.
Returns:
WorkflowEnablerSession - Workflow c-enabler session.

getEnablerSession

public WorkflowEnablerSession getEnablerSession(java.lang.String configFile,
                                                java.lang.String sessionName,
                                                java.lang.String orgName,
                                                java.lang.String user,
                                                java.lang.String password)
                                         throws WLPIException,
                                                WLPINoActiveTemplateException
Creates a workflow c-enabler session with the specified c-enabler XML configuration file, session name, organization name, username and password.

If the specified user is null, then the information is taken from the current request. For example, inside a servlet, the information will be retrieved from the remote HTTP user.

If the specified name matches the name of an existing workflow c-enabler session, then getEnablerSession() returns the existing workflow c-enabler session.

Parameters:
configFile - C-enabler XML configuration file.
sessionName - Name of the c-enabler session.
orgName - Name of the WLPI organization.
user - Username for WLPI access.
password - Password for WLPI access.
Returns:
WorkflowEnablerSession - Workflow c-enabler session.

getExistingEnablerSession

public WorkflowEnablerSession getExistingEnablerSession(java.lang.String sessionName)
Gets an existing workflow c-enabler session with the specified session name.

Parameters:
sessionName - Name of the workflow c-enabler session to retrieve.
Returns:
WorkflowEnablerSession - Existing workflow c-enabler session, or null if no matching session name was found.