Processor (OpenText Process Suite Platform 10.8 Java SDK API)

java.lang.Object
- com.eibus.soap.Processor

All Implemented Interfaces:: SOAPMessageListener, SOAPMessageListenerEx

public class Processor
extends java.lang.Object
implements SOAPMessageListener, SOAPMessageListenerEx

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_SOAP_PREFIX`
`static int`	`EXIT_1` Stopped
`static int`	`EXIT_11` Unknown Error
`static int`	`EXIT_12` Connection Error
`static int`	`EXIT_13` Connection Error
`static int`	`EXIT_14` Configuration Error
`static int`	`EXIT_15` Keystore fetch error
`static int`	`EXIT_IGNORE` Ignorable Exit by the Monitor.
`static int`	`EXIT_LICENSE_ERROR` Exit due to Licence error
`static int`	`EXIT_UNEXPECTED_EXCEPTION` Exit due to an exception
`static boolean`	`isLDAPService`
`static XPathMetaInfo`	`metaInfoForSOAPNS`
`static java.lang.String`	`SOAP_NAMESPACE`
`static java.lang.String`	`SOAP_NODE_SETTING_COLLECTION`

Constructor Summary

Constructors
Constructor and Description
`Processor(java.lang.String name)` Deprecated. use other constructor instead.
`Processor(java.lang.String processorDN, LDAPDirectory directory, IManagedComponent parentManagedComponent)` Create a new processor that connects to the Cordys ESB as the specified name.
`Processor(java.lang.String processorDN, LDAPDirectory directory, IManagedComponent parentManagedComponent, byte[] keystoreBuffer, char[] keystorePassword, java.lang.String signingCertificateAlias, char[] signingKeyPassword)` Create a new processor that connects to the Cordys ESB as the specified name.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addApplicationConnector(ApplicationConnector mapper)` Add a ApplicationConnector to the list of registered applicationConnectors.
`void`	`addRunningStateChangeHandler(RunningStateChangeHandler handler)`
`void`	`close()` Closes the connection to the Cordys ESB and afterwards all the registered XML applicationConnectors.
`Connector`	`getConnector()` Returns the Connector to the Cordys ESB that is opened by this soap processor.
`LDAPDirectory`	`getDirectory()` Returns the Directory Server proxy used by this soap processor.
`Document`	`getDocument()`
`XMLSecPKCS12`	`getKeyStore()`
`IManagedComponent`	`getManagedComponent()`
`MethodDefinition`	`getMethodDefinition(java.lang.String methodName, java.lang.String methodNamespace)` Returns the definition of the method with the specified name and namespace as configured for this soap processor in the LDAP.
`java.lang.String`	`getOrganization()` Returns the organization in which this soap processor is running.
`DN`	`getOrganizationDN()` Returns the organization in which this soap processor is running.
`int`	`getProcessorConfigurationNode()` Retrieves the node containing the processor configuration.
`java.lang.String`	`getProcessorStatus()`
`Registration`	`getRegistration()` Returns the Access Control Registration object that is available for this Processor.
`java.lang.String`	`getSOAPNode()` Returns the name of the soap node for which this soap processor is running.
`java.lang.String`	`getSoapNodeCertificateAlias()`
`char[]`	`getSoapNodeKeyPassword()`
`ISettingsCollection`	`getSOAPNodeSettingCollection()` Returns the SOAP Node setting Collection.
`LDAPEntry`	`getSOAPProcessorEntry()` Returns the ldap entry with which this processor was created
`WSSHandler`	`getWSSHandler()`
`boolean`	`isReady()`
`static void`	`main(java.lang.String[] args)`
`boolean`	`onReceive(int envelope)` Is called by the Connector to the Cordys ESB when a SOAP message comes in.
`boolean`	`onReceive(Message message)` Is called by the Connector to the Cordys ESB when a SOAP message comes in.
`void`	`open()` Opens all the registered applicationConnectors and then the connection to the Cordys ESB.
`static void`	`raiseJVMOutOfMemoryAlert(int processID, java.lang.String machineName)`
`void`	`reset()`
`void`	`setAbortTime(int timeInSeconds)` Sets the abort time for all transactions and eventually the Processor.
`void`	`setAclCacheSize(int cacheSize)` Sets the ACL cache size.
`void`	`setAclRoleCacheSize(int cacheSize)` Sets the ACL cache size.
`LDAPDirectory`	`setDirectory(LDAPDirectory directory)`
`void`	`setGracefulCompleteTime(int timeInSeconds)` Sets the time for the graceful completion of the Transactions.
`protected void`	`stopInformationThread()`

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

- Field Detail
  - SOAP_NODE_SETTING_COLLECTION
```
public static final java.lang.String SOAP_NODE_SETTING_COLLECTION
```
    See Also:
    
    Constant Field Values
  - EXIT_15
```
public static final int EXIT_15
```
    Keystore fetch error
    
    See Also:
    
    Constant Field Values
  - EXIT_14
```
public static final int EXIT_14
```
    Configuration Error
    
    See Also:
    
    Constant Field Values
  - EXIT_13
```
public static final int EXIT_13
```
    Connection Error
    
    See Also:
    
    Constant Field Values
  - EXIT_12
```
public static final int EXIT_12
```
    Connection Error
    
    See Also:
    
    Constant Field Values
  - EXIT_11
```
public static final int EXIT_11
```
    Unknown Error
    
    See Also:
    
    Constant Field Values
  - EXIT_1
```
public static final int EXIT_1
```
    Stopped
    
    See Also:
    
    Constant Field Values
  - EXIT_UNEXPECTED_EXCEPTION
```
public static final int EXIT_UNEXPECTED_EXCEPTION
```
    Exit due to an exception
    
    See Also:
    
    Constant Field Values
  - EXIT_LICENSE_ERROR
```
public static final int EXIT_LICENSE_ERROR
```
    Exit due to Licence error
    
    See Also:
    
    Constant Field Values
  - EXIT_IGNORE
```
public static final int EXIT_IGNORE
```
    Ignorable Exit by the Monitor.
    
    See Also:
    
    Constant Field Values
  - SOAP_NAMESPACE
```
public static final java.lang.String SOAP_NAMESPACE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SOAP_PREFIX
```
public static final java.lang.String DEFAULT_SOAP_PREFIX
```
    See Also:
    
    Constant Field Values
  - metaInfoForSOAPNS
```
public static final XPathMetaInfo metaInfoForSOAPNS
```
  - isLDAPService
```
public static boolean isLDAPService
```
- Constructor Detail
  - Processor
```
@Deprecated
public Processor(java.lang.String name)
                       throws ExceptionGroup,
                              DirectoryException
```
    Deprecated. use other constructor instead.
    
    Create a new processor that connects to the Cordys ESB under the specified name.
    
    Parameters:
    
    name - The name for which to start a connection to the Cordys ESB LDAP information. Notice, this constructor does not do any initialization of LDAP information about the name. Use this constructor if you want to create an anonymous soap processor (i.e., one that is not registered in LDAP).
    
    Throws:
    
    ExceptionGroup
    
    DirectoryException
  - Processor
```
public Processor(java.lang.String processorDN,
                 LDAPDirectory directory,
                 IManagedComponent parentManagedComponent)
          throws ExceptionGroup,
                 DirectoryException
```
    Create a new processor that connects to the Cordys ESB as the specified name.
    
    Parameters:
    
    entry - The LDAPEntry for which to start a connection to the Cordys ESB LDAP information. Notice, this constructor uses the information in the LDAP entry to initialize itself and load its applicationConnectors.
    
    parentManagedComponent - parent managed component of this soap processor. This is usually the OS process hosting this processor.
    
    Throws:
    
    ExceptionGroup
    
    DirectoryException
  - Processor
```
public Processor(java.lang.String processorDN,
                 LDAPDirectory directory,
                 IManagedComponent parentManagedComponent,
                 byte[] keystoreBuffer,
                 char[] keystorePassword,
                 java.lang.String signingCertificateAlias,
                 char[] signingKeyPassword)
          throws ExceptionGroup,
                 DirectoryException
```
    Create a new processor that connects to the Cordys ESB as the specified name.
    
    Parameters:
    
    processorDN -
    
    directory -
    
    parentManagedComponent -
    
    keystoreBuffer -
    
    keystorePassword -
    
    signingCertificateAlias -
    
    signingKeyPassword -
    
    Throws:
    
    ExceptionGroup
    
    DirectoryException
- Method Detail
  - getSOAPNode
```
public java.lang.String getSOAPNode()
```
    Returns the name of the soap node for which this soap processor is running.
    
    Returns:
    
    The name of the soap node for which this soap processor is running.
  - getSOAPProcessorEntry
```
public LDAPEntry getSOAPProcessorEntry()
```
    Returns the ldap entry with which this processor was created
  - getOrganization
```
public java.lang.String getOrganization()
```
    Returns the organization in which this soap processor is running.
    
    Returns:
    
    The name of the organization in which this soap processor is running.
  - getOrganizationDN
```
public DN getOrganizationDN()
```
    Returns the organization in which this soap processor is running.
    
    Returns:
    
    The name of the organization in which this soap processor is running.
  - setAclCacheSize
```
public void setAclCacheSize(int cacheSize)
```
    Sets the ACL cache size.
    
    Parameters:
    
    cacheSize -
  - setAclRoleCacheSize
```
public void setAclRoleCacheSize(int cacheSize)
```
    Sets the ACL cache size.
    
    Parameters:
    
    cacheSize -
  - setGracefulCompleteTime
```
public void setGracefulCompleteTime(int timeInSeconds)
```
    Sets the time for the graceful completion of the Transactions.
    
    Parameters:
    
    timeInSeconds -
  - setAbortTime
```
public void setAbortTime(int timeInSeconds)
```
    Sets the abort time for all transactions and eventually the Processor.
    
    Parameters:
    
    timeInSeconds -
  - addRunningStateChangeHandler
```
public void addRunningStateChangeHandler(RunningStateChangeHandler handler)
```
  - getRegistration
```
public Registration getRegistration()
```
    Returns the Access Control Registration object that is available for this Processor.
  - getDocument
```
public Document getDocument()
```
  - addApplicationConnector
```
public void addApplicationConnector(ApplicationConnector mapper)
```
    Add a ApplicationConnector to the list of registered applicationConnectors.
    
    Parameters:
    
    mapper - The ApplicationConnector to add.
  - isReady
```
public boolean isReady()
```
  - open
```
public void open()
```
    Opens all the registered applicationConnectors and then the connection to the Cordys ESB. If you call addApplicationConnector() after you call open, make sure that the added Application connector is already opened.
  - reset
```
public void reset()
```
  - close
```
public void close()
```
    Closes the connection to the Cordys ESB and afterwards all the registered XML applicationConnectors.
  - stopInformationThread
```
protected void stopInformationThread()
```
  - getProcessorStatus
```
public java.lang.String getProcessorStatus()
```
  - onReceive
```
public boolean onReceive(int envelope)
```
    Is called by the Connector to the Cordys ESB when a SOAP message comes in. This method will create a SOAPTransaction object for each message, which handles the message, and probably sends a reply.
    
    Specified by:
    
    onReceive in interface SOAPMessageListener
    
    Parameters:
    
    envelope - The incoming message. This is an XML tree, which you can manipulate with the functions in Node.
    
    Returns:
    
    true If you want the connector to delete the Soap Message after you processed it, false otherwise.
  - onReceive
```
public boolean onReceive(Message message)
```
    Is called by the Connector to the Cordys ESB when a SOAP message comes in. This method will create a SOAPTransaction object for each message, which handles the message, and probably sends a reply.
    
    Specified by:
    
    onReceive in interface SOAPMessageListenerEx
    
    Parameters:
    
    message - The incoming message. This is an wrapper around the envelope, which contains an XML tree, which you can manipulate with the functions in Node.
    
    Returns:
    
    true If you want the connector to delete the Soap Message after you processed it, false otherwise.
  - getDirectory
```
public LDAPDirectory getDirectory()
```
    Returns the Directory Server proxy used by this soap processor.
    
    Returns:
    
    a proxy to the directory server
  - setDirectory
```
public LDAPDirectory setDirectory(LDAPDirectory directory)
```
  - getConnector
```
public Connector getConnector()
```
    Returns the Connector to the Cordys ESB that is opened by this soap processor.
    
    Returns:
    
    The Connector to the Cordys ESB for this soap processor.
  - getManagedComponent
```
public IManagedComponent getManagedComponent()
```
  - main
```
public static void main(java.lang.String[] args)
                 throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getMethodDefinition
```
public MethodDefinition getMethodDefinition(java.lang.String methodName,
                                            java.lang.String methodNamespace)
```
    Returns the definition of the method with the specified name and namespace as configured for this soap processor in the LDAP.
  - getProcessorConfigurationNode
```
public int getProcessorConfigurationNode()
```
    Retrieves the node containing the processor configuration. NOTE: For internal use only.
    
    Returns:
    
    the node containing the processor configuration.
  - getKeyStore
```
public XMLSecPKCS12 getKeyStore()
                         throws java.security.KeyStoreException,
                                XMLSecException
```
    Throws:
    
    java.security.KeyStoreException
    
    XMLSecException
  - getWSSHandler
```
public WSSHandler getWSSHandler()
                         throws java.security.KeyStoreException,
                                WSSecurityException,
                                XMLSecException
```
    Throws:
    
    java.security.KeyStoreException
    
    WSSecurityException
    
    XMLSecException
  - getSoapNodeCertificateAlias
```
public java.lang.String getSoapNodeCertificateAlias()
                                             throws java.security.KeyStoreException
```
    Throws:
    
    java.security.KeyStoreException
  - getSoapNodeKeyPassword
```
public char[] getSoapNodeKeyPassword()
                              throws java.security.KeyStoreException
```
    Throws:
    
    java.security.KeyStoreException
  - getSOAPNodeSettingCollection
```
public ISettingsCollection getSOAPNodeSettingCollection()
```
    Returns the SOAP Node setting Collection.
    
    Returns:
    
    SOAP Node setting collection
  - raiseJVMOutOfMemoryAlert
```
public static void raiseJVMOutOfMemoryAlert(int processID,
                                            java.lang.String machineName)
```

Class Processor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SOAP_NODE_SETTING_COLLECTION

EXIT_15

EXIT_14

EXIT_13

EXIT_12

EXIT_11

EXIT_1

EXIT_UNEXPECTED_EXCEPTION

EXIT_LICENSE_ERROR

EXIT_IGNORE

SOAP_NAMESPACE

DEFAULT_SOAP_PREFIX

metaInfoForSOAPNS

isLDAPService

Constructor Detail

Processor

Processor

Processor

Method Detail

getSOAPNode

getSOAPProcessorEntry

getOrganization

getOrganizationDN

setAclCacheSize

setAclRoleCacheSize

setGracefulCompleteTime

setAbortTime

addRunningStateChangeHandler

getRegistration

getDocument

addApplicationConnector

isReady

open

reset

close

stopInformationThread

getProcessorStatus

onReceive

onReceive

getDirectory

setDirectory

getConnector

getManagedComponent

main

getMethodDefinition

getProcessorConfigurationNode

getKeyStore

getWSSHandler

getSoapNodeCertificateAlias

getSoapNodeKeyPassword

getSOAPNodeSettingCollection

raiseJVMOutOfMemoryAlert