BPMServiceClientFactory (Oracle Fusion Middleware BPM-Services Java API Reference for Oracle BPM Suite)

java.lang.Object
- oracle.bpm.client.BPMServiceClientFactory

All Implemented Interfaces:

java.io.Serializable
```
public class BPMServiceClientFactory
extends java.lang.Object
implements java.io.Serializable
```
Creates instance of IWorkflowServiceClient, IBPMUserAuthenticationService or IBPMServiceClient.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`LOCAL_CLIENT` LOCAL Clients will access the BPM and 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 BPM and 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_CLIENT is only for Internal use

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IBPMServiceClient`	`getBPMServiceClient()` Gets `IBPMServiceClint` Service client instance
`IBPMUserAuthenticationService`	`getBPMUserAuthenticationService()` Gets `IBPMUserAuthenticationService` Service client instance
`ICaseManagementServiceClient`	`getCaseManagementServiceClient()` Gets `ICaseManagementServiceClient` Service client instance
`static BPMServiceClientFactory`	`getInstance(java.util.Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties, java.lang.String serverName, java.util.logging.Logger logger)` Get a BPMServiceClientFactory instance 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, BPMServiceClientFactory.REMOTE_CLIENT); properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_PROVIDER_URL, "t3://<host>:<port>"); properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_SECURITY_CREDENTIALS, "welcome1"); properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_SECURITY_PRINCIPAL, "demoadmin"); BPMServiceClientFactory factory = BPMServiceClientFactory.getInstance(properties, null);
`static BPMServiceClientFactory`	`getInstance(java.lang.String clientType, java.lang.String serverName, java.util.logging.Logger logger)` Get a BPMServiceClientFactory instance Usage Samples: BPMServiceClientFactory factory = BPMServiceClientFactory.getInstance(BPMServiceClientFactory.REMOTE_CLIENT, serverName, logger);
`static BPMServiceClientFactory`	`getInstance(WorkflowServicesClientConfigurationType wscc, java.util.logging.Logger logger)` Get a `BPMServiceClientFactory` factory instance for default server defined in `WorkflowServicesClientConfigurationType` object
`IWorkflowServiceClient`	`getWorkflowServiceClient()` Gets Workflow Service Client

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_CLIENT is only for Internal use
    
    See Also:
    
    Constant Field Values
  - LOCAL_CLIENT
```
public static final java.lang.String LOCAL_CLIENT
```
    LOCAL Clients will access the BPM and 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 BPM and 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
- Method Detail
  - getInstance
```
public static BPMServiceClientFactory getInstance(java.util.Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties,
                                                  java.lang.String serverName,
                                                  java.util.logging.Logger logger)
                                           throws BPMServiceClientException
```
    Get a BPMServiceClientFactory instance
    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, BPMServiceClientFactory.REMOTE_CLIENT);
    properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_PROVIDER_URL, "t3://<host>:<port>");
    properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_SECURITY_CREDENTIALS, "welcome1");
    properties.put(IWorkflowServiceClientConstants.CONNECTION_PROPERTY.EJB_SECURITY_PRINCIPAL, "demoadmin");
    BPMServiceClientFactory factory = BPMServiceClientFactory.getInstance(properties, null);
    
    Parameters:
    
    serverName - a name of server from client configuration
    
    logger - a Logger value
    
    Returns:
    
    an BPMServiceClientFactory instance
    
    Throws:
    
    BPMServiceClientException - if an error occurs
  - getInstance
```
public static BPMServiceClientFactory getInstance(java.lang.String clientType,
                                                  java.lang.String serverName,
                                                  java.util.logging.Logger logger)
                                           throws BPMServiceClientException
```
    Get a BPMServiceClientFactory instance
    Usage Samples:
    
    BPMServiceClientFactory factory = BPMServiceClientFactory.getInstance(BPMServiceClientFactory.REMOTE_CLIENT, serverName, logger);
    
    Parameters:
    
    clientType - client types from BPMServiceClientFactory.REMOTE_CLIENT etc.
    
    serverName - a name of server from client configuration
    
    logger - a Logger value
    
    Returns:
    
    an BPMServiceClientFactory instance
    
    Throws:
    
    BPMServiceClientException - if an error occurs
  - getInstance
```
public static BPMServiceClientFactory getInstance(WorkflowServicesClientConfigurationType wscc,
                                                  java.util.logging.Logger logger)
                                           throws BPMServiceClientException
```
    Get a BPMServiceClientFactory factory instance for default server defined in WorkflowServicesClientConfigurationType object
    
    Parameters:
    
    wscc - a WorkflowServicesClientConfigurationType object. If null, configuration file wf_client_config.xml should be in CLASSPATH with proper setting for requested client,else BPMServiceClientException is thrown
    
    logger - a Logger value
    
    Returns:
    
    an BPMServiceClientFactory value
    
    Throws:
    
    BPMServiceClientException - if an error occurs
  - getWorkflowServiceClient
```
public IWorkflowServiceClient getWorkflowServiceClient()
                                                throws BPMServiceClientException
```
    Gets Workflow Service Client
    
    Returns:
    
    IBPMUserAuthenticationService instance
    
    Throws:
    
    BPMServiceClientException - if an error occurs
  - getBPMUserAuthenticationService
```
public IBPMUserAuthenticationService getBPMUserAuthenticationService()
                                                              throws BPMServiceClientException
```
    Gets IBPMUserAuthenticationService Service client instance
    
    Returns:
    
    IBPMUserAuthenticationService instance
    
    Throws:
    
    BPMServiceClientException - if an error occurs
  - getBPMServiceClient
```
public IBPMServiceClient getBPMServiceClient()
                                      throws BPMServiceClientException
```
    Gets IBPMServiceClint Service client instance
    
    Returns:
    
    IBPMServiceClient instance
    
    Throws:
    
    BPMServiceClientException - if an error occurs
  - getCaseManagementServiceClient
```
public ICaseManagementServiceClient getCaseManagementServiceClient()
                                                            throws BPMServiceClientException
```
    Gets ICaseManagementServiceClient Service client instance
    
    Returns:
    
    ICaseManagementServiceClient instance
    
    Throws:
    
    BPMServiceClientException - if an error occurs

Class BPMServiceClientFactory

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SOAP_CLIENT

LOCAL_CLIENT

REMOTE_CLIENT

Method Detail

getInstance

getInstance

getInstance

getWorkflowServiceClient

getBPMUserAuthenticationService

getBPMServiceClient

getCaseManagementServiceClient