Package com.adobe.idp.dsc.clientsdk
Classpublic final class ServiceClientFactory
InheritanceServiceClientFactory Inheritance Object

Responsible for maintaining client configuration and providing a ServiceClient instance for an application to use.


Public Methods
 MethodDefined by
  
FaultCallBackInfo createFaultCallBackInfo(String serviceName, String operationName, String version)
Sets a fault callback.
ServiceClientFactory
  
ServiceClientFactory createInstance()
[static] Creates a new instance of ServiceClientFactory that is used to send invocation requests to a LiveCycle service.
ServiceClientFactory
  
ServiceClientFactory createInstance(Context aContext)
[static] Creates a new instance of ServiceClientFactory that is used to send invocation requests to a LiveCycle service.
ServiceClientFactory
  
ServiceClientFactory createInstance(Properties aProperties)
[static] Creates a new instance of ServiceClientFactory that is used to send invocation requests to a LiveCycle service.
ServiceClientFactory
  
ServiceClientFactory createInstance(String aResourceName)
[static] Creates a ServiceClientFactory object with a resource property.
ServiceClientFactory
  
ServiceClientFactory createInstance(URL aPropertyURL)
[static] Creates a ServiceClientFactory with properties located at the specified URL.
ServiceClientFactory
  
InvocationRequest createInvocationRequest(String aServiceName, String aOperationName, Map aParameterInput, boolean synchronous)
Creates an InvocationRequest object using the specified LiveCycle service name, operation name, parameter values, and operation mode.
ServiceClientFactory
  
ResponseCallBackInfo createResponseCallBackInfo(String serviceName, String operationName, String version)
Sets a response callback.
ServiceClientFactory
  
Context getContext()
Returns the context that maintains information such as the user credential values.
ServiceClientFactory
  
Properties getDefaultProperties()
[static] Gets the default properties to use for ServiceClientFactory's created throw the empty arg createInstance call.
ServiceClientFactory
  
Object getProperty(String aPropertyName)
Gets a property value that was used to create the ServiceClientFactory object.
ServiceClientFactory
  
ServiceClient getServiceClient()
Returns an instance of a ServiceClient object.
ServiceClientFactory
  
void installThrowHandler(ThrowHandler th)
[static] Replaces the global default ThrowHandler instance in order to provide specialized exception handling.
ServiceClientFactory
  
void setContext(Context aContext)
Sets the context to use.
ServiceClientFactory
  
void setDefaultProperties(Properties aProps)
[static] Sets the Default Properties to use for ServiceClientFactorie's created throw the empty arg createInstance call.
ServiceClientFactory
Method Detail
createFaultCallBackInfo()
public FaultCallBackInfo createFaultCallBackInfo(String serviceName, String operationName, String version)

Sets a fault callback.

Parameters

serviceName
 
operationName
 
version

Returns
createInstance() 
public static ServiceClientFactory createInstance()

Creates a new instance of ServiceClientFactory that is used to send invocation requests to a LiveCycle service. For information, see Invoking LiveCycle Services.

Returns
An instance of ServiceClientFactory, or null an error occurs.
createInstance() 
public static ServiceClientFactory createInstance(Context aContext)

Creates a new instance of ServiceClientFactory that is used to send invocation requests to a LiveCycle service.

Parameters

aContext — A com.adobe.idp.Context object that is used for authentication and authorization purposes.

Returns
A ServiceClientFactory object, or null an error occurs.
createInstance() 
public static ServiceClientFactory createInstance(Properties aProperties)

Creates a new instance of ServiceClientFactory that is used to send invocation requests to a LiveCycle service.

Parameters

aProperties — A java.util.Properties object that stores connection properties. For information, see Invoking LiveCycle Services.

Returns
A ServiceClientFactory object, or null if an error occurs.
createInstance() 
public static ServiceClientFactory createInstance(String aResourceName)

Creates a ServiceClientFactory object with a resource property. The specified resource must be located within the classpath of the client application.

Parameters

aResourceName — The name of the resource.

Returns
A ServiceClientFactory object, or null if an error occurs.
createInstance() 
public static ServiceClientFactory createInstance(URL aPropertyURL)

Creates a ServiceClientFactory with properties located at the specified URL.

Parameters

aPropertyURL — The URL to the property file.

Returns
A ServiceClientFactory object, or null if an error occurs.
createInvocationRequest() 
public InvocationRequest createInvocationRequest(String aServiceName, String aOperationName, Map aParameterInput, boolean synchronous)

Creates an InvocationRequest object using the specified LiveCycle service name, operation name, parameter values, and operation mode.

Parameters

aServiceName — The name of the LiveCycle service to invoke.
 
aOperationName — The LiveCycle operation name. The operation must belong to the LiveCycle service specified by the aServiceName parameter.
 
aParameterInput — A map that contains parameter values that are required by the operation.
 
synchronous — Set to true if the operation is executed synchronously, otherwise, set it to false.

Returns
An InvocationRequest object.

Throws
A — DSCRuntimeException if the service name or the operation name is null or an empty string.
createResponseCallBackInfo() 
public ResponseCallBackInfo createResponseCallBackInfo(String serviceName, String operationName, String version)

Sets a response callback.

Parameters

serviceName
 
operationName
 
version

Returns
getContext() 
public Context getContext()

Returns the context that maintains information such as the user credential values.

Returns
A Context object or null if the context has not been established.
getDefaultProperties() 
public static Properties getDefaultProperties()

Gets the default properties to use for ServiceClientFactory's created throw the empty arg createInstance call.

Returns
The default properties to use for ServiceClientFactory's created throw the empty arg createInstance call.
getProperty() 
public Object getProperty(String aPropertyName)

Gets a property value that was used to create the ServiceClientFactory object.

Parameters

aPropertyName — The name of the property.

Returns
The value of the specified property.
getServiceClient() 
public ServiceClient getServiceClient()

Returns an instance of a ServiceClient object. For information, see Invoking LiveCycle Services.

Returns
A ServiceClient object.
installThrowHandler() 
public static void installThrowHandler(ThrowHandler th)

Replaces the global default ThrowHandler instance in order to provide specialized exception handling. All exceptions originating within the client will pass through the installed handler regardless of the ServiceClientFactory instance the originated them.

Parameters

th — the ThrowHandler instance that should be used to handle exception sarising during invocation request/response.

setContext() 
public void setContext(Context aContext)

Sets the context to use.

Parameters

aContext — A Context object.

setDefaultProperties() 
public static void setDefaultProperties(Properties aProps)

Sets the Default Properties to use for ServiceClientFactorie's created throw the empty arg createInstance call. Note: these properties only apply when used outside of the container, but will be ignored for code running inside the Service Container.

Parameters

aProps




© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Sep 27 2007, 8:38 AM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/idp/dsc/clientsdk/ServiceClientFactory.html