Skip navigation links

oracle.bpel.services.workflow.client
Class WorkflowServiceClientFactory

java.lang.Object
oracle.bpel.services.workflow.client.WorkflowServiceClientFactory

public class WorkflowServiceClientFactory

extends java.lang.Object

Field Summary

static java.lang.String	JAVA_CLIENT Deprecated.
static java.lang.String	LOCAL_CLIENT For Oracle SOA internal use only - LOCAL Clients will access the Workflow Services through Local EJB layer Client calls will become local ejb calls made directly to the EJB implementing the service
static java.lang.String	REMOTE_CLIENT REMOTE Clients will access the Workflow Services through Remote EJB layer Client calls will become remote ejb calls made directly to the EJB implementing the service
static java.lang.String	REMOTE_LOCAL_CLIENT Deprecated. REMOTE Clients will access the Workflow Services through Remote EJB layer Client calls will become remote ejb calls made directly to the EJB implementing the service
static java.lang.String	SOAP_CLIENT SOAP Clients will access the Workflow Services through SOAP layer Client calls will become SOAP messages to invoke the corresponding exposed SOAP service
static java.lang.String	WSIF_CLIENT Deprecated.

Constructor Summary

WorkflowServiceClientFactory()

Method Summary

static ITaskQueryService	getFederatedTaskQueryService(java.lang.String clientType, WorkflowServicesClientConfigurationType wscct, java.util.List<java.lang.String> requestedServers, java.util.logging.Logger logger) Gets federated task query service This API is available only if Approval Management Extension is enabled
static ITaskQueryService	getFederatedTaskQueryService(WorkflowServicesClientConfigurationType wscct, java.util.List<java.lang.String> requestedServers, java.util.logging.Logger logger) Gets federated task query service This API is available only if Approval Management Extension is enabled
static BPMIdentityConfigService	getSOAPIdentityConfigServiceClient(java.util.Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties, java.util.logging.Logger logger) Get a soap identity service client Usage Samples: Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties = new HashMap<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String>(); properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.SOAP_END_POINT_ROOT, "http://<host>:<port>"); BPMIdentityService client = WorkflowServiceClientFactory.getSOAPIdentityServiceClient(realName, properties, null);
static BPMIdentityService	getSOAPIdentityServiceClient(java.lang.String realmName, java.util.Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties, java.util.logging.Logger logger) Get a soap identity service client Usage Samples: Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties = new HashMap<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String>(); properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.SOAP_END_POINT_ROOT, "http://<host>:<port>"); BPMIdentityService client = WorkflowServiceClientFactory.getSOAPIdentityServiceClient(realName, properties, null);
static IWorkflowServiceClient	getWorkflowServiceClient(java.util.Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties, java.util.logging.Logger logger) Get a workflow service client for server specified as default in the client configuration Usage Samples: For remote EJB clients Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties = new HashMap<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String>(); >properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.CLIENT_TYPE, WorkflowServiceClientFactory.REMOTE_CLIENT); properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_PROVIDER_URL, "t3://<host>:<port>"); properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_SECURITY_CREDENTIALS, "<password>"); properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_SECURITY_PRINCIPAL, "demoadmin"); IWorkflowServiceClient client = WorkflowServiceClientFactory.getWorkflowServiceClient(properties, null); For remote SOAP clients Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties = new HashMap<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String>(); >properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.CLIENT_TYPE, WorkflowServiceClientFactory.SOAP_CLIENT); properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.SOAP_END_POINT_ROOT, "http://<host>:<port"); IWorkflowServiceClient client = WorkflowServiceClientFactory.getWorkflowServiceClient(properties, null);
static IWorkflowServiceClient	getWorkflowServiceClient(java.util.Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties, java.lang.String serverName, java.util.logging.Logger logger) Get a workflow service client by server name This API is available only if Approval Management Extension is enabled Usage Samples: For remote EJB clients Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties = new HashMap<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String>(); >properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.CLIENT_TYPE, WorkflowServiceClientFactory.REMOTE_CLIENT); properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_PROVIDER_URL, "t3://<host>:<port>"); properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_SECURITY_CREDENTIALS, "<password>"); properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_SECURITY_PRINCIPAL, "demoadmin"); IWorkflowServiceClient client = WorkflowServiceClientFactory.getWorkflowServiceClient(properties, null); For remote SOAP clients Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties = new HashMap<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String>(); * >properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.CLIENT_TYPE, WorkflowServiceClientFactory.SOAP_CLIENT); properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.SOAP_END_POINT_ROOT, "http://<host>:<port>"); IWorkflowServiceClient client = WorkflowServiceClientFactory.getWorkflowServiceClient(properties, null);
static IWorkflowServiceClient	getWorkflowServiceClient(java.lang.String clientType) Get a workflow service client
static IWorkflowServiceClient	getWorkflowServiceClient(java.lang.String clientType, java.util.Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties, java.util.logging.Logger logger) Get a workflow service client Usage Samples: For remote EJB clients Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties = new HashMap<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String>(); properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_PROVIDER_URL, "t3://<host>:<port>"); properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_SECURITY_CREDENTIALS, "<password>"); properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_SECURITY_PRINCIPAL, "demoadmin"); IWorkflowServiceClient client = WorkflowServiceClientFactory.getWorkflowServiceClient(WorkflowServiceClientFactory.REMOTE_CLIENT, properties, null); For remote SOAP clients Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties = new HashMap<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String>(); properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.SOAP_END_POINT_ROOT, "http://<host>:<port>"); IWorkflowServiceClient client = WorkflowServiceClientFactory.getWorkflowServiceClient(WorkflowServiceClientFactory.SOAP_CLIENT, properties, null);
static IWorkflowServiceClient	getWorkflowServiceClient(java.lang.String clientType, WorkflowServicesClientConfigurationType wscc, java.util.logging.Logger logger) Get a workflow service client for default server defined in WorkflowServicesClientConfigurationType object.
static IWorkflowServiceClient	getWorkflowServiceClient(WorkflowServicesClientConfigurationType wscc, java.util.logging.Logger logger) Get a workflow service client for default server defined in WorkflowServicesClientConfigurationType object This API is available only if Approval Management Extension is enabled

Methods inherited from class java.lang.Object

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

Field Detail

SOAP_CLIENT

public static final java.lang.String SOAP_CLIENT

SOAP Clients will access the Workflow Services through SOAP layer Client calls will become SOAP messages to invoke the corresponding exposed SOAP service

See Also:

Constant Field Values

WSIF_CLIENT

public static final java.lang.String WSIF_CLIENT

Deprecated.

See Also:

Constant Field Values

JAVA_CLIENT

public static final java.lang.String JAVA_CLIENT

Deprecated.

See Also:

Constant Field Values

LOCAL_CLIENT

public static final java.lang.String LOCAL_CLIENT

For Oracle SOA internal use only - LOCAL Clients will access the Workflow Services through Local EJB layer Client calls will become local ejb calls made directly to the EJB implementing the service

See Also:

Constant Field Values

REMOTE_CLIENT

public static final java.lang.String REMOTE_CLIENT

REMOTE Clients will access the Workflow Services through Remote EJB layer Client calls will become remote ejb calls made directly to the EJB implementing the service

See Also:

Constant Field Values

REMOTE_LOCAL_CLIENT

public static final java.lang.String REMOTE_LOCAL_CLIENT

Deprecated. REMOTE Clients will access the Workflow Services through Remote EJB layer Client calls will become remote ejb calls made directly to the EJB implementing the service

See Also:

Constant Field Values

Constructor Detail

WorkflowServiceClientFactory

public WorkflowServiceClientFactory()

Method Detail

getWorkflowServiceClient

public static IWorkflowServiceClient getWorkflowServiceClient(java.lang.String clientType)

Get a workflow service client

Parameters:

clientType - a String value

Returns:

an IWorkflowServiceClient value

getWorkflowServiceClient

public static IWorkflowServiceClient getWorkflowServiceClient(java.lang.String clientType,
                                                              java.util.Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties,
                                                              java.util.logging.Logger logger)

Get a workflow service client Usage Samples:

For remote EJB clients
Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties = new HashMap<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String>();
properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_PROVIDER_URL, "t3://<host>:<port>");
properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_SECURITY_CREDENTIALS, "<password>");
properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_SECURITY_PRINCIPAL, "demoadmin");
IWorkflowServiceClient client = WorkflowServiceClientFactory.getWorkflowServiceClient(WorkflowServiceClientFactory.REMOTE_CLIENT, properties, null);

For remote SOAP clients
Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties = new HashMap<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String>();
properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.SOAP_END_POINT_ROOT, "http://<host>:<port>");
IWorkflowServiceClient client = WorkflowServiceClientFactory.getWorkflowServiceClient(WorkflowServiceClientFactory.SOAP_CLIENT, properties, null);

Parameters:

clientType - a String value

properties - a map of properties specifying connection information. The values in this map will be used in establishing connection to the workflow service

logger - a Logger value

Returns:

an IWorkflowServiceClient value

getWorkflowServiceClient

public static IWorkflowServiceClient getWorkflowServiceClient(java.util.Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties,
                                                              java.util.logging.Logger logger)
                                                       throws WorkflowException

Get a workflow service client for server specified as default in the client configuration Usage Samples:

For remote EJB clients
Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties = new HashMap<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String>();
>properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.CLIENT_TYPE, WorkflowServiceClientFactory.REMOTE_CLIENT);
properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_PROVIDER_URL, "t3://<host>:<port>");
properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_SECURITY_CREDENTIALS, "<password>");
properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_SECURITY_PRINCIPAL, "demoadmin");
IWorkflowServiceClient client = WorkflowServiceClientFactory.getWorkflowServiceClient(properties, null);

For remote SOAP clients
Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties = new HashMap<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String>();
>properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.CLIENT_TYPE, WorkflowServiceClientFactory.SOAP_CLIENT);
properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.SOAP_END_POINT_ROOT, "http://<host>:<port");
IWorkflowServiceClient client = WorkflowServiceClientFactory.getWorkflowServiceClient(properties, null);

Parameters:

properties - a map of properties specifying connection information. The values in this map will be used in establishing connection to the workflow service. The property IWorkflowServiceClientConstants.CONNECTION_PROPERTY.CLIENT_TYPE with value either SOAP_CLIENT or REMOTE_CLIENT overwrites the client type defined in the client configuration file.

logger - a Logger value

Returns:

an IWorkflowServiceClient value

Throws:

WorkflowException

getWorkflowServiceClient

public static IWorkflowServiceClient getWorkflowServiceClient(java.util.Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties,
                                                              java.lang.String serverName,
                                                              java.util.logging.Logger logger)
                                                       throws WorkflowException

Get a workflow service client by server name
This API is available only if Approval Management Extension is enabled
Usage Samples:

For remote EJB clients
Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties = new HashMap<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String>();
>properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.CLIENT_TYPE, WorkflowServiceClientFactory.REMOTE_CLIENT);
properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_PROVIDER_URL, "t3://<host>:<port>");
properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_SECURITY_CREDENTIALS, "<password>");
properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_SECURITY_PRINCIPAL, "demoadmin");
IWorkflowServiceClient client = WorkflowServiceClientFactory.getWorkflowServiceClient(properties, null);

For remote SOAP clients
Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties = new HashMap<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String>(); *
>properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.CLIENT_TYPE, WorkflowServiceClientFactory.SOAP_CLIENT);
properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.SOAP_END_POINT_ROOT, "http://<host>:<port>");
IWorkflowServiceClient client = WorkflowServiceClientFactory.getWorkflowServiceClient(properties, null);

Parameters:

properties - a map of properties specifying connection information. The values in this map will be used in establishing connection to the workflow service. The property IWorkflowServiceClientConstants.CONNECTION_PROPERTY.CLIENT_TYPE with value either SOAP_CLIENT or REMOTE_CLIENT overwrites the client type defined in the client configuration file.

serverName - a name of server from client configuration

logger - a Logger value

Returns:

an IWorkflowServiceClient value

Throws:

WorkflowException

getWorkflowServiceClient

public static IWorkflowServiceClient getWorkflowServiceClient(java.lang.String clientType,
                                                              WorkflowServicesClientConfigurationType wscc,
                                                              java.util.logging.Logger logger)
                                                       throws WorkflowException

Get a workflow service client for default server defined in WorkflowServicesClientConfigurationType object.
This API is available only if Approval Management Extension is enabled

Parameters:

clientType - a String value

wscc - a WorkflowServicesClientConfigurationType object. If null, configuration file wf_client_config.xml should be in CLASSPATH with proper setting for requested client,else WorkflowException is thrown

logger - a Logger value

Returns:

an IWorkflowServiceClient value

Throws:

WorkflowException

getWorkflowServiceClient

public static IWorkflowServiceClient getWorkflowServiceClient(WorkflowServicesClientConfigurationType wscc,
                                                              java.util.logging.Logger logger)
                                                       throws WorkflowException

Get a workflow service client for default server defined in WorkflowServicesClientConfigurationType object
This API is available only if Approval Management Extension is enabled

Parameters:

clientType - a String value

wscc - a WorkflowServicesClientConfigurationType object. If null, configuration file wf_client_config.xml should be in CLASSPATH with proper setting for requested client,else WorkflowException is thrown

logger - a Logger value

Returns:

an IWorkflowServiceClient value

Throws:

WorkflowException

getSOAPIdentityServiceClient

public static BPMIdentityService getSOAPIdentityServiceClient(java.lang.String realmName,
                                                              java.util.Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties,
                                                              java.util.logging.Logger logger)

Get a soap identity service client Usage Samples:

Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties = new HashMap<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String>();
properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.SOAP_END_POINT_ROOT, "http://<host>:<port>");
BPMIdentityService client = WorkflowServiceClientFactory.getSOAPIdentityServiceClient(realName, properties, null);

Parameters:

realmName - a realm name, if null default realm name is used

properties - a map of properties specifying connection information. The values in this map will be used in establishing connection to the workflow service

logger - a Logger value

Returns:

an BPMIdentityService value

getSOAPIdentityConfigServiceClient

public static BPMIdentityConfigService getSOAPIdentityConfigServiceClient(java.util.Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties,
                                                                          java.util.logging.Logger logger)

Get a soap identity service client Usage Samples:

Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties = new HashMap<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String>();
properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.SOAP_END_POINT_ROOT, "http://<host>:<port>");
BPMIdentityService client = WorkflowServiceClientFactory.getSOAPIdentityServiceClient(realName, properties, null);

Parameters:

realmName - a realm name, if null default realm name is used

properties - a map of properties specifying connection information. The values in this map will be used in establishing connection to the workflow service

logger - a Logger value

Returns:

an BPMIdentityConfigService value

getFederatedTaskQueryService

public static ITaskQueryService getFederatedTaskQueryService(java.lang.String clientType,
                                                             WorkflowServicesClientConfigurationType wscct,
                                                             java.util.List<java.lang.String> requestedServers,
                                                             java.util.logging.Logger logger)
                                                      throws WorkflowException

Gets federated task query service
This API is available only if Approval Management Extension is enabled

Parameters:

clientType - a clientType: REMOTE_CLIENT or SOAP_CLIENT. The value overwrite all clientType values defined in wscct or in the configuration file

wscct - WorkflowServicesClientConfigurationType object. If wscct is null, configuration object is loaded from wf_client_config.xml.

requestedServers - a list of server names, if null all servers from configurations

Returns:

an ITaskQueryService value, a federated task query service

Throws:

WorkflowException

getFederatedTaskQueryService

public static ITaskQueryService getFederatedTaskQueryService(WorkflowServicesClientConfigurationType wscct,
                                                             java.util.List<java.lang.String> requestedServers,
                                                             java.util.logging.Logger logger)
                                                      throws WorkflowException

Gets federated task query service
This API is available only if Approval Management Extension is enabled

Parameters:

wscct - WorkflowServicesClientConfigurationType object. If wscct is null, configuration object is loaded from wf_client_config.xml.

requestedServers - a list of server names, if null all servers from configurations

Returns:

an ITaskQueryService value, a federated task query service

Throws:

WorkflowException

Skip navigation links