com.ibm.di.connector
Class DSMLv2SOAPConnector

java.lang.Object
  com.ibm.di.connector.Connector
      com.ibm.di.connector.DSMLv2SOAPConnector

All Implemented Interfaces:

ConnectorInterface, VersionInfoInterface

public class DSMLv2SOAPConnector
extends Connector
implements ConnectorInterface

The DSMLv2 SOAP Connector implements the DSMLv2 standard (http://www.oasis-open.org/committees/dsml/docs/DSMLv2.doc). It is is able to execute DSMLv2 requests against a DSML Server. It also provides the option to use DSML SOAP binding.

Field Summary

static String	ATTR_NAME_HTTP_BODY
static String	ATTR_NAME_HTTP_CHARACTER_SET
static String	ATTR_NAME_HTTP_CONTENT_TYPE
static String	ATTR_NAME_HTTP_METHOD
static String	ATTR_NAME_HTTP_REMOTE_PASSWORD
static String	ATTR_NAME_HTTP_REMOTE_USER
static String	ATTR_NAME_HTTP_URL
static String	BASE_OBJECT
static String	HTTP_BASIC_AUTH
static String	PARAMETER_AUTH_METHOD
static String	PARAMETER_BINARY_ATTRIBUTES
static String	PARAMETER_PASSWORD
static String	PARAMETER_SEARCH_BASE
static String	PARAMETER_SEARCH_FILTER
static String	PARAMETER_SEARCH_SCOPE
static String	PARAMETER_SOAPBINDING
static String	PARAMETER_URL
static String	PARAMETER_USERNAME
static String	SINGLE_LEVEL
static String	WHOLE_SUBTREE

Fields inherited from class com.ibm.di.connector.Connector

ALL_MODES, myLog, PROPERTY_MESSAGE, PROPERTY_READER, PROPERTY_WRITER

Constructor Summary

DSMLv2SOAPConnector()
Default constructor.

Method Summary

void	deleteEntry(Entry aEntry, SearchCriteria aSearch) Deletes an existing entry.
Entry	findEntry(SearchCriteria aSearch) Finds an existing entry.
Entry	getNextEntry() Returns the next Entry from the connector.
String	getVersion() Returns version information.
void	initialize(Object o) Initialize the connector.
boolean	isDeltaSupported() Returns true if this connector is able to perform delta updates
void	modEntry(Entry aEntry, SearchCriteria aSearch) Modifies an existing entry.
void	modEntry(Entry aNewEntry, SearchCriteria aSearch, Entry aOldEntry) Modifies an existing entry.
void	putEntry(Entry aPutEntry) Adds a new entry to the data source
Entry	queryReply(Entry aQueryEntry) Performs a query/reply operations.
void	selectEntries() Prepare the Connector for sequential read.

Methods inherited from class com.ibm.di.connector.Connector

addFindEntry, allModes, clearFindEntries, debug, debugMode, findEntry, getBoolean, getClassInstance, getConfiguration, getContext, getFindEntryCount, getFirstFindEntry, getLog, getMaxDuplicateEntries, getModes, getModes, getName, getNextClient, getNextFindEntry, getParam, getParser, getProperty, getPushbackEntry, getRawConnectorConfiguration, getRSInterface, hasConfigValue, hasParser, initParser, isExceptionFatal, isIOException, logmsg, pushback, queryOperations, querySchema, queryTables, reconnect, reconnect, registerScriptBeans, replyEntry, setConfiguration, setContext, setCurrent, setLog, setMaxDuplicateEntries, setModes, setModes, setName, setParam, setParser, setProperty, setRSInterface, terminate, terminateServer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.di.connector.ConnectorInterface

getConfiguration, getContext, getFindEntryCount, getFirstFindEntry, getMaxDuplicateEntries, getName, getNextClient, getNextFindEntry, getParam, getPushbackEntry, getRawConnectorConfiguration, isExceptionFatal, isIOException, pushback, queryOperations, querySchema, reconnect, registerScriptBeans, replyEntry, setConfiguration, setContext, setCurrent, setLog, setMaxDuplicateEntries, setName, setParam, setRSInterface, terminate, terminateServer

Field Detail

PARAMETER_URL

public static final String PARAMETER_URL

See Also:

Constant Field Values

PARAMETER_AUTH_METHOD

public static final String PARAMETER_AUTH_METHOD

See Also:

Constant Field Values

PARAMETER_USERNAME

public static final String PARAMETER_USERNAME

See Also:

Constant Field Values

PARAMETER_PASSWORD

public static final String PARAMETER_PASSWORD

See Also:

Constant Field Values

PARAMETER_BINARY_ATTRIBUTES

public static final String PARAMETER_BINARY_ATTRIBUTES

See Also:

Constant Field Values

PARAMETER_SEARCH_BASE

public static final String PARAMETER_SEARCH_BASE

See Also:

Constant Field Values

PARAMETER_SEARCH_FILTER

public static final String PARAMETER_SEARCH_FILTER

See Also:

Constant Field Values

PARAMETER_SEARCH_SCOPE

public static final String PARAMETER_SEARCH_SCOPE

See Also:

Constant Field Values

PARAMETER_SOAPBINDING

public static final String PARAMETER_SOAPBINDING

See Also:

Constant Field Values

ATTR_NAME_HTTP_URL

public static final String ATTR_NAME_HTTP_URL

See Also:

Constant Field Values

ATTR_NAME_HTTP_METHOD

public static final String ATTR_NAME_HTTP_METHOD

See Also:

Constant Field Values

ATTR_NAME_HTTP_REMOTE_USER

public static final String ATTR_NAME_HTTP_REMOTE_USER

See Also:

Constant Field Values

ATTR_NAME_HTTP_REMOTE_PASSWORD

public static final String ATTR_NAME_HTTP_REMOTE_PASSWORD

See Also:

Constant Field Values

ATTR_NAME_HTTP_BODY

public static final String ATTR_NAME_HTTP_BODY

See Also:

Constant Field Values

ATTR_NAME_HTTP_CONTENT_TYPE

public static final String ATTR_NAME_HTTP_CONTENT_TYPE

See Also:

Constant Field Values

ATTR_NAME_HTTP_CHARACTER_SET

public static final String ATTR_NAME_HTTP_CHARACTER_SET

See Also:

Constant Field Values

HTTP_BASIC_AUTH

public static final String HTTP_BASIC_AUTH

See Also:

Constant Field Values

BASE_OBJECT

public static final String BASE_OBJECT

See Also:

Constant Field Values

SINGLE_LEVEL

public static final String SINGLE_LEVEL

See Also:

Constant Field Values

WHOLE_SUBTREE

public static final String WHOLE_SUBTREE

See Also:

Constant Field Values

Constructor Detail

DSMLv2SOAPConnector

public DSMLv2SOAPConnector()

Default constructor. Instatiates the internally used DSMLv2 Parser and HTTP Parser.

Method Detail

initialize

public void initialize(Object o)
                throws Exception

Description copied from class: Connector

Initialize the connector. The connector may be passed a parameter of any kind by the user. It is up to the connector to determine whether this object can be used or not. The parameter is typically provided by a user script. When an AssemblyLine initializes it's Connectors, they are passed a ConnectorMode object.

Specified by:

initialize in interface ConnectorInterface

Overrides:

initialize in class Connector

Parameters:

o - User provided parameter

Throws:

Exception

putEntry

public void putEntry(Entry aPutEntry)
              throws Exception

Description copied from class: Connector

Adds a new entry to the data source

Specified by:

putEntry in interface ConnectorInterface

Overrides:

putEntry in class Connector

Parameters:

aPutEntry - The entry data to add

Throws:

Exception - Any exceptions thrown by the connector's underlying classes

queryReply

public Entry queryReply(Entry aQueryEntry)
                 throws Exception

Description copied from class: Connector

Performs a query/reply operations.

Specified by:

queryReply in interface ConnectorInterface

Overrides:

queryReply in class Connector

Parameters:

aQueryEntry - The data used in outgoing call

Returns:

The entry returned by the peer

Throws:

Exception - Any exceptions thrown by the connector's underlying classes

selectEntries

public void selectEntries()
                   throws Exception

Description copied from class: Connector

Prepare the Connector for sequential read. If necessary, create a result set to be used for getNextEntry(). When the Connector is used as an Iterator in an AssemblyLine, this method will be called. Default is an empty method.

Specified by:

selectEntries in interface ConnectorInterface

Overrides:

selectEntries in class Connector

Throws:

Exception

getNextEntry

public Entry getNextEntry()
                   throws Exception

Description copied from class: Connector

Returns the next Entry from the connector. The entry is populated with attributes and values from the next entry in the input set.

Specified by:

getNextEntry in interface ConnectorInterface

Overrides:

getNextEntry in class Connector

Returns:

- the next Entry, or null if no more data

Throws:

Exception

See Also:

Connector.selectEntries()

findEntry

public Entry findEntry(SearchCriteria aSearch)
                throws Exception

Description copied from class: Connector

Finds an existing entry. The search criteria specifies which entry to locate

Specified by:

findEntry in interface ConnectorInterface

Overrides:

findEntry in class Connector

Parameters:

aSearch - The search criteria used to locate the entry to be modified

Returns:

The entry found, or null if no or multiple entries found

Throws:

Exception - Any exceptions thrown by the connector's underlying classes

modEntry

public void modEntry(Entry aEntry,
                     SearchCriteria aSearch)
              throws Exception

Description copied from class: Connector

Modifies an existing entry. The new entry data is given by the entry parameter and the search criteria specifies which entry to modify.

Specified by:

modEntry in interface ConnectorInterface

Overrides:

modEntry in class Connector

Parameters:

aEntry - The entry data

aSearch - The search criteria used to locate the entry to be modified

Throws:

Exception - Any exceptions thrown by the connector's underlying classes

modEntry

public void modEntry(Entry aNewEntry,
                     SearchCriteria aSearch,
                     Entry aOldEntry)
              throws Exception

Description copied from class: Connector

Modifies an existing entry. The new entry data is given by the entry parameter and the search criteria specifies which entry to modify.

Specified by:

modEntry in interface ConnectorInterface

Overrides:

modEntry in class Connector

Parameters:

aNewEntry - The entry data

aSearch - The search criteria used to locate the entry to be modified

aOldEntry - The old entry found by the search criteria

Throws:

Exception - Any exceptions thrown by the connector's underlying classes

deleteEntry

public void deleteEntry(Entry aEntry,
                        SearchCriteria aSearch)
                 throws Exception

Description copied from class: Connector

Deletes an existing entry. The search criteria specifies which entry to modify. Some connectors may silently ignore the search criteria. For example, the LDAP connector will use the distinguished name ($dn) from the entry parameter (if it exists) rather than expanding the search criteria and search for the entry. Each connector's inner semantics governs wheter the search parameter is used or not.

Specified by:

deleteEntry in interface ConnectorInterface

Overrides:

deleteEntry in class Connector

Parameters:

aEntry - The entry data

aSearch - The search criteria used to locate the entry to be deleted

Throws:

Exception - Any exceptions thrown by the connector's underlying classes

isDeltaSupported

public boolean isDeltaSupported()

Description copied from class: Connector

Returns true if this connector is able to perform delta updates

Specified by:

isDeltaSupported in interface ConnectorInterface

Overrides:

isDeltaSupported in class Connector

Returns:

true if delta updates are supported, false otherwise

getVersion

public String getVersion()

Returns version information.

Specified by:

getVersion in interface VersionInfoInterface