Oracle Fusion Middleware
Java API Reference for Oracle BPM Suite
11g Release 1 (11.1.1.7.0)
E25378-07

oracle.bpm.client
Class BPMServiceClientContext

java.lang.Object
  extended by oracle.bpm.client.BPMServiceClientContext
All Implemented Interfaces:
java.io.Serializable

public class BPMServiceClientContext
extends java.lang.Object
implements java.io.Serializable

Sets context for BPM Service client, provides connection properties, client side logger, client side configuration etc.

Since:
release specific (what release of product did this appear in)
See Also:
Serialized Form

Nested Class Summary
static class BPMServiceClientContext.BPM_SERVICE
          BPM Services {agQueryService, bpmUserAutenticationService, instanceManagementService, ....}.
 
Constructor Summary
BPMServiceClientContext(java.util.Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties, java.util.logging.Logger logger)
          Creates a new BPMServiceClientContext instance.
BPMServiceClientContext(java.util.Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties, java.lang.String serverName, java.util.logging.Logger logger)
          Creates a new BPMServiceClientContext instance.
BPMServiceClientContext(WorkflowServicesClientConfigurationType wsClientConfig, java.util.logging.Logger logger)
          Creates a new BPMServiceClientContext instance.
 
Method Summary
 javax.naming.InitialContext getJNDIInitialContext()
          gets JNDI initial context.
 java.util.logging.Logger getLogger()
          Gets getLogger object for context.
static javax.xml.ws.spi.ServiceDelegate getService(BPMServiceClientContext.BPM_SERVICE service1, java.net.URL wsdlURL, java.lang.String endPoint, javax.xml.namespace.QName portQName, javax.xml.namespace.QName serviceQName, java.util.logging.Logger logger)
          Gets a service.
static java.lang.String getServiceUriSuffix(BPMServiceClientContext.BPM_SERVICE service)
           
 java.lang.String getSOAPEndPoint(BPMServiceClientContext.BPM_SERVICE service)
          Gets soap root end point
 java.lang.String getSOAPIdentityPropagationMode()
          Gets Identity Propagation Mode
 org.w3c.dom.Element getSOAPSecurityPolicy()
          Gets SOAP Security Policy
 oracle.bpel.services.workflow.client.WorkflowServiceClientContext getWorkflowServiceClientContext()
           
 WorkflowServicesClientConfigurationType getWorkflowServicesClientConfiguration()
           
 boolean isDiscoveryOfEndPoint()
          Returns boolean true if discoveryOfEndPoint flag is set in the default Server instance, false otherwise.
 boolean isDiscoveryOfEndPoint(java.util.Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> map)
          Returns boolean true if the DISCOVERY_OF_END_POINT flag is set to true in the map, false otherwise.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BPMServiceClientContext

public BPMServiceClientContext(WorkflowServicesClientConfigurationType wsClientConfig,
                               java.util.logging.Logger logger)
                        throws BPMServiceClientException
Creates a new BPMServiceClientContext instance.

Parameters:
wsClientConfig - WorkflowServicesClientConfigurationType instance.
logger - a Logger object
Throws:
java.lang.IllegalArgumentException - if wsClientConfig is null;
BPMServiceClientException

BPMServiceClientContext

public BPMServiceClientContext(java.util.Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties,
                               java.util.logging.Logger logger)
                        throws BPMServiceClientException
Creates a new BPMServiceClientContext instance.

Parameters:
properties - a map of client properties, Map
logger -
Throws:
BPMServiceClientException

BPMServiceClientContext

public BPMServiceClientContext(java.util.Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> properties,
                               java.lang.String serverName,
                               java.util.logging.Logger logger)
                        throws BPMServiceClientException
Creates a new BPMServiceClientContext instance.

Parameters:
properties - a map of client properties, Map
serverName - a name of server from wf_client_config.xml
logger -
Throws:
BPMServiceClientException
Method Detail

getServiceUriSuffix

public static java.lang.String getServiceUriSuffix(BPMServiceClientContext.BPM_SERVICE service)

getService

public static javax.xml.ws.spi.ServiceDelegate getService(BPMServiceClientContext.BPM_SERVICE service1,
                                                          java.net.URL wsdlURL,
                                                          java.lang.String endPoint,
                                                          javax.xml.namespace.QName portQName,
                                                          javax.xml.namespace.QName serviceQName,
                                                          java.util.logging.Logger logger)
Gets a service. Services are cached based on workflow service ids. If the cache entry is found it would make sure that the end point is the same. If the end point is different, it will purge the old old entry and recreate a new one

Parameters:
service - a BPM_SERVICE value
wsdlURL - an URL value
endPoint - a String value
portQName - a QName value
serviceQName - a QName value
logger - a Logger value
Returns:
a ServiceDelegate value

getWorkflowServicesClientConfiguration

public WorkflowServicesClientConfigurationType getWorkflowServicesClientConfiguration()

getWorkflowServiceClientContext

public oracle.bpel.services.workflow.client.WorkflowServiceClientContext getWorkflowServiceClientContext()

getJNDIInitialContext

public javax.naming.InitialContext getJNDIInitialContext()
                                                  throws BPMServiceClientException
gets JNDI initial context.

Returns:
an InitialContext value
Throws:
BPMServiceClientException - if an error occurs

isDiscoveryOfEndPoint

public boolean isDiscoveryOfEndPoint()
Returns boolean true if discoveryOfEndPoint flag is set in the default Server instance, false otherwise.

Returns:

isDiscoveryOfEndPoint

public boolean isDiscoveryOfEndPoint(java.util.Map<IWorkflowServiceClientConstants.CONNECTION_PROPERTY,java.lang.String> map)
Returns boolean true if the DISCOVERY_OF_END_POINT flag is set to true in the map, false otherwise.

Parameters:
map -
Returns:

getSOAPEndPoint

public java.lang.String getSOAPEndPoint(BPMServiceClientContext.BPM_SERVICE service)
                                 throws BPMServiceClientException
Gets soap root end point

Parameters:
service - a BPM_SERVICE value
Returns:
a String value
Throws:
BPMServiceClientException - if an error occurs

getLogger

public java.util.logging.Logger getLogger()
Gets getLogger object for context.

Returns:
a Logger value

getSOAPIdentityPropagationMode

public java.lang.String getSOAPIdentityPropagationMode()
                                                throws BPMServiceClientException
Gets Identity Propagation Mode

Returns:
a String value: "dynamic" or "descriptor" if SAML-TOKEN propagation is set, else "none"
Throws:
BPMServiceClientException - if an error occurs

getSOAPSecurityPolicy

public org.w3c.dom.Element getSOAPSecurityPolicy()
                                          throws BPMServiceClientException
Gets SOAP Security Policy

Returns:
a Element policy
Throws:
BPMServiceClientException - if an error occurs

Oracle Fusion Middleware
Java API Reference for Oracle BPM Suite
11g Release 1 (11.1.1.7.0)
E25378-07

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