Context (webMethods Java API Reference)

java.lang.Object
- com.wm.app.b2b.client.BaseContext
- - com.wm.app.b2b.client.Context

Direct Known Subclasses:

JSONClient
```
public class Context
extends BaseContext
```
The com.wm.app.b2b.client package contains the classes necessary to establish client connectivity to a webMethods Integration Server. Client to Server communications are carried out via HTTP POSTs in either a binary or XML encoding.
Provides session management (with pinger), applet support, and threadedInvokes.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CONTENT_TYPE_HTML`
`static int`	`CONTXT0003`
`static int`	`CONTXT0004`
`static int`	`CONTXT0005`
`static int`	`CONTXT0006`
`static int`	`CONTXT0007`
`static int`	`CONTXT0008`
`static int`	`CONTXT0009`
`static int`	`DISCONNECT_MSG`
`static java.lang.String`	`HTTP_HEADER_CONTENT_TYPE`
`static int`	`HTTP_OK_RESPONSE_CODE`
`static int`	`PING_FAILED_MSG`
`static int`	`PING_SERVER_MSG`
`static int`	`TIME_OUT_MSG`
`static int`	`TRY_PING_MSG`
`static int`	`UNKNOWN_HOST_MSG`
`static int`	`UNNOWN_PARTNER_MSG`

Fields inherited from class com.wm.app.b2b.client.BaseContext
NO_SSL, RPC_BIN, RPC_IDAT, RPC_XML, SSL_128, SSL_40

Constructor Summary

Constructors
Constructor and Description
`Context()` Create a new unconnected Client Context and default to a binary RPC transport.
`Context(java.applet.Applet a)` Create a new Client Context and specify that the client is running as an Applet.
`Context(int rpcType)` Create a new unconnected Client Context utilizing the specified RPC type.
`Context(int rpcType, Values context)`
`Context(Values context)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appletSetup(java.applet.Applet a)`
`void`	`cleanUpConnection()` Cleanup when a connection has been lost.
`void`	`connect(java.lang.String server)` Connects this Context to an Integration Server and establishes session state on the server.
`void`	`connect(java.lang.String server, byte[] certificate)` Connects the Context to a Integration Server and establishes session state on the server.
`void`	`connect(java.lang.String host, int port, java.lang.String user, java.lang.String pass)` Connects the Context to an Integration Server and establishes session state on the server.
`void`	`connect(java.lang.String server, java.lang.String user, java.lang.String pass)` Connects the Context to an Integration Server and establishes session state on the server.
`void`	`disconnect()` Disconnects the Context and flushes session state on the Server.
`void`	`disconnect(Values in)` Disconnects the Context and flushes session state on the Server.
`void`	`fakeConnect()`
`java.util.Hashtable<java.lang.String,java.lang.String>`	`getCookies()` Returns the values of the Set-Cookie headers from the previous response.
`java.lang.String[]`	`getCookiesAsArray()` Returns the values of the Set-Cookie headers from the previous response in an array of Strings.
`Namespace`	`getNamespace()`
`Query`	`getQuery()`
`IData`	`invoke(NSName svcName, IData data)`
`Values`	`invoke(NSName svcName, Values data)` Makes a call to the Integration Server to invoke the specified functionality.
`IData`	`invoke(java.lang.String ifc, java.lang.String svc, IData data)`
`IData`	`invoke(java.lang.String ifc, java.lang.String svc, IData data, boolean isConnect)`
`Values`	`invoke(java.lang.String ifc, java.lang.String svc, Values data)` Makes a call to the Integration Server to invoke the specified functionality.
`Values`	`invoke(java.lang.String ifc, java.lang.String svc, Values data, boolean isConnect)`
`InvokeThread`	`invokeThreaded(NSName svcName, Values data)` Calls invoke asynchronously and returns an InvokeThread.
`InvokeThread`	`invokeThreaded(java.lang.String ifc, java.lang.String svc, Values data)` Calls invoke asynchronously and returns an InvokeThread.
`void`	`setCookie(java.lang.String cookie)` Sets the HTTP cookie to be used with the next service invocation.

Methods inherited from class com.wm.app.b2b.client.BaseContext
getSSLSupport, isClusteredEnv, isConnected, isSecure, isUseJSSE, setAllowRedir, setAuthentication, setFixedUri, setProxy, setRetryServer, setSecure, setSecureProxy, setSSLCertificates, setSSLCertificates, setSSLCertificates, setUseJSSE

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- PING_FAILED_MSG
```
public static final int PING_FAILED_MSG
```
  See Also:
  
  Constant Field Values
- PING_SERVER_MSG
```
public static final int PING_SERVER_MSG
```
  See Also:
  
  Constant Field Values
- UNKNOWN_HOST_MSG
```
public static final int UNKNOWN_HOST_MSG
```
  See Also:
  
  Constant Field Values
- UNNOWN_PARTNER_MSG
```
public static final int UNNOWN_PARTNER_MSG
```
  See Also:
  
  Constant Field Values
- DISCONNECT_MSG
```
public static final int DISCONNECT_MSG
```
  See Also:
  
  Constant Field Values
- TIME_OUT_MSG
```
public static final int TIME_OUT_MSG
```
  See Also:
  
  Constant Field Values
- TRY_PING_MSG
```
public static final int TRY_PING_MSG
```
  See Also:
  
  Constant Field Values
- CONTXT0003
```
public static final int CONTXT0003
```
  See Also:
  
  Constant Field Values
- CONTXT0004
```
public static final int CONTXT0004
```
  See Also:
  
  Constant Field Values
- CONTXT0005
```
public static final int CONTXT0005
```
  See Also:
  
  Constant Field Values
- CONTXT0006
```
public static final int CONTXT0006
```
  See Also:
  
  Constant Field Values
- CONTXT0007
```
public static final int CONTXT0007
```
  See Also:
  
  Constant Field Values
- CONTXT0008
```
public static final int CONTXT0008
```
  See Also:
  
  Constant Field Values
- CONTXT0009
```
public static final int CONTXT0009
```
  See Also:
  
  Constant Field Values
- HTTP_OK_RESPONSE_CODE
```
public static final int HTTP_OK_RESPONSE_CODE
```
  See Also:
  
  Constant Field Values
- HTTP_HEADER_CONTENT_TYPE
```
public static final java.lang.String HTTP_HEADER_CONTENT_TYPE
```
  See Also:
  
  Constant Field Values
- CONTENT_TYPE_HTML
```
public static final java.lang.String CONTENT_TYPE_HTML
```
  See Also:
  
  Constant Field Values

Constructor Detail

Context
```
public Context(Values context)
```

Context

public Context(int rpcType,
               Values context)

Context
```
public Context()
```
Create a new unconnected Client Context and default to a binary RPC transport.

Context
```
public Context(int rpcType)
```
Create a new unconnected Client Context utilizing the specified RPC type. Valid RPC types are:
- Context.RPC_BIN
- Context.RPC_XML
Parameters:

rpcType - RPC type to use.

Context

public Context(java.applet.Applet a)
        throws ServiceException

Create a new Client Context and specify that the client is running as an Applet. Note that the Context is automatically connected to the server specified by applet <PARAM> tags. Applets are uniquely constrained so this constructor must be used by clients which are applets. Not doing so will result in network security exceptions.

Valid <PARAM> attributes are:

SERVER	Server endpoint in the form host:port
SERVERUSER	User to log in as
SERVERPASS	User's password
SECURE	Boolean to select SSL or not. Values: true or false
DEBUG	Set debug level. Values: 0-10
FIXEDURI	For running clients that access Integration servers through web servers with the CGI-gateway

Throws:: ServiceException

Method Detail
- appletSetup
```
public final void appletSetup(java.applet.Applet a)
                       throws ServiceException
```
  Throws:
  
  ServiceException
- getNamespace
```
public Namespace getNamespace()
```
- getQuery
```
public Query getQuery()
```
- fakeConnect
```
public void fakeConnect()
```
- invokeThreaded
```
public InvokeThread invokeThreaded(NSName svcName,
                                   Values data)
```
  Calls invoke asynchronously and returns an InvokeThread. The getData method can then be called on the returned InvokeThread to retrieve the call results. The invoke retries the service invocation when a transient connection failure occurs.
  
  Parameters:
  
  svcName - Service namespace name
  
  data - input data for the service invocation
  
  See Also:
  
  invoke
- invokeThreaded
```
public InvokeThread invokeThreaded(java.lang.String ifc,
                                   java.lang.String svc,
                                   Values data)
```
  Calls invoke asynchronously and returns an InvokeThread. The getData method can then be called on the returned InvokeThread to retrieve the call results. The invoke retries the service invocation when a transient connection failure occurs.
  
  Parameters:
  
  ifc - Interface name of the service to invoke
  
  svc - service to invoke
  
  data - input data for the service invocation
  
  See Also:
  
  invoke
- invoke
```
public Values invoke(NSName svcName,
                     Values data)
              throws ServiceException
```
  Makes a call to the Integration Server to invoke the specified functionality. connect() must be called first or the call will fail. The invoke retries the service invocation when a transient connection failure occurs.
  
  Parameters:
  
  svcName - Service Namespace Name
  
  data - Service input data
  
  Returns:
  
  Values object of service invocation results.
  
  Throws:
  
  ServiceException
- invoke
```
public IData invoke(NSName svcName,
                    IData data)
             throws ServiceException
```
  Throws:
  
  ServiceException
- invoke
```
public Values invoke(java.lang.String ifc,
                     java.lang.String svc,
                     Values data)
              throws ServiceException
```
  Makes a call to the Integration Server to invoke the specified functionality. connect() must be called first or the call will fail. The invoke retries the service invocation when a transient connection failure occurs.
  
  Parameters:
  
  ifc - Target Interface
  
  svc - Target Service
  
  data - Service input data
  
  Returns:
  
  Values object of service invocation results.
  
  Throws:
  
  ServiceException
- invoke
```
public IData invoke(java.lang.String ifc,
                    java.lang.String svc,
                    IData data)
             throws ServiceException
```
  Throws:
  
  ServiceException
- connect
```
public void connect(java.lang.String host,
                    int port,
                    java.lang.String user,
                    java.lang.String pass)
             throws ServiceException
```
  Connects the Context to an Integration Server and establishes session state on the server. If supplied, it also sets user credentials.
  
  Parameters:
  
  host - hostName of Server endpoint.
  
  port - part of Server endpoint --=* optional parameters *=--
  
  user - User to connect as
  
  pass - User's password
  
  Throws:
  
  ServiceException
- connect
```
public final void connect(java.lang.String server,
                          java.lang.String user,
                          java.lang.String pass)
                   throws ServiceException
```
  Connects the Context to an Integration Server and establishes session state on the server. If supplied, it also sets user credentials.
  
  Parameters:
  
  server - Server endpoint in the form: host:port --=* optional parameters *=--
  
  user - User to connect as
  
  pass - User's password
  
  Throws:
  
  ServiceException
- connect
```
public void connect(java.lang.String server)
             throws ServiceException
```
  Connects this Context to an Integration Server and establishes session state on the server.
  
  Parameters:
  
  server - Server endpoint in the form: host:port
  
  Throws:
  
  ServiceException
- connect
```
public void connect(java.lang.String server,
                    byte[] certificate)
             throws ServiceException
```
  Connects the Context to a Integration Server and establishes session state on the server. The byte image of the certificate can be obtained via a call to getCertificate(). Authentication with this certificate is performed at the application layer and is independent of certificates used to establish secure connections like SSL.
  
  Parameters:
  
  server - Server endpoint in the form: host:port
  
  certificate - byte image of X.509 certificate to submit
  
  Throws:
  
  ServiceException
- disconnect
```
public void disconnect(Values in)
```
  Disconnects the Context and flushes session state on the Server.
- disconnect
```
public void disconnect()
```
  Disconnects the Context and flushes session state on the Server.
- getCookies
```
public java.util.Hashtable<java.lang.String,java.lang.String> getCookies()
```
  Returns the values of the Set-Cookie headers from the previous response.
- getCookiesAsArray
```
public java.lang.String[] getCookiesAsArray()
```
  Returns the values of the Set-Cookie headers from the previous response in an array of Strings.
- setCookie
```
public void setCookie(java.lang.String cookie)
```
  Sets the HTTP cookie to be used with the next service invocation. By default, the cookie will be set to the session ID. Use this method to set the cookie to a different value. If null is passed to setCookie, Context.invoke will set the cookie to the session ID.
  If a response contains a Set-Cookie header field and you want to set the cookie in the next invoke to that entire value, you can use getCookieAsArray and setCookie:
```
 String[] cookies = context.getCookiesAsarray();
 StringBuilder cookie = new StringBuilder();
 for (String cookieVal : cookies) {
     cookie.append(cookieVal);
     cookie.append("; ");
 }
 cookie.setLength(cookie.getLength()-2); // remove trailing "; "
 context.setCookie(cookie.toString());
```
  Parameters:
  
  cookie - The value of the Cookie header to be used in the next service invocation.
- cleanUpConnection
```
public void cleanUpConnection()
```
  Cleanup when a connection has been lost. Similar to disconnect(), except invoking wm.server/disconnect is not necessary.
- invoke
```
public Values invoke(java.lang.String ifc,
                     java.lang.String svc,
                     Values data,
                     boolean isConnect)
              throws ServiceException
```
  Throws:
  
  ServiceException
- invoke
```
public IData invoke(java.lang.String ifc,
                    java.lang.String svc,
                    IData data,
                    boolean isConnect)
             throws ServiceException
```
  Throws:
  
  ServiceException

Class Context

Field Summary

Fields inherited from class com.wm.app.b2b.client.BaseContext

Constructor Summary

Method Summary

Methods inherited from class com.wm.app.b2b.client.BaseContext

Methods inherited from class java.lang.Object

Field Detail

PING_FAILED_MSG

PING_SERVER_MSG

UNKNOWN_HOST_MSG

UNNOWN_PARTNER_MSG

DISCONNECT_MSG

TIME_OUT_MSG

TRY_PING_MSG

CONTXT0003

CONTXT0004

CONTXT0005

CONTXT0006

CONTXT0007

CONTXT0008

CONTXT0009

HTTP_OK_RESPONSE_CODE

HTTP_HEADER_CONTENT_TYPE

CONTENT_TYPE_HTML

Constructor Detail

Context

Context

Context

Context

Context

Method Detail

appletSetup

getNamespace

getQuery

fakeConnect

invokeThreaded

invokeThreaded

invoke

invoke

invoke

invoke

connect

connect

connect

connect

disconnect

disconnect

getCookies

getCookiesAsArray

setCookie

cleanUpConnection

invoke

invoke