com.sap.aii.mapping.lookup

Class SystemAccessor

java.lang.Object
  com.sap.aii.mapping.lookup.SystemAccessor

public final class SystemAccessor
extends Object

Accessor for a communication with a remote system. The communication is established via adapters of the Integration Server. You can get an instance with help of LookupService.getSystemAccessor(Channel).

After executing your communication calls, the accessor must be closed through the secure cleanup idiom. See the following example.

// 1. Get a system accessor for a channel.
SystemAccessor accessor = LookupService.getSystemAccessor(channel);
try{

// 2. Create a payload according to the data type.
// Use service.getBinaryPayload() for binary payload,
// or service.getTextPayload() for text payloads.
Payload payload = LookupService.getXmlPayload(inputStream);
// 3. Set the operation name and namespace; optional step, only necessary if the
// used adapter needs these parameters.
accessor.setOperationName(interfaceName);
accessor.setOperationNamespace(interfaceNS);
// 4. Execute lookup.
Payload result = accessor.call(payload);
...
// Steps 2. to 4. can be executed several times.
...

}finally{

// 5. close the accessor in order to free resources.
if (accessor!=null) accessor.close();

}

Since:

SAP NetWeaver '04 SPS 13

See Also:

LookupService

Nested Class Summary

static interface

SystemAccessor.Internal Internal system accessor.

Method Summary

Payload	call(Payload payload) Executes a lookup call.
void	close() Closes this accessor and releases any resources associated with the accessor.
void	setOperationName(String aOperationName) Sets the operation name.
void	setOperationNamespace(String aOperationNamespace) Sets the operation namespace.

Methods inherited from class java.lang.Object

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

Method Detail

setOperationName

public void setOperationName(String aOperationName)

Sets the operation name. The default value is "". The operation name describes the payload together with the operation namespace ( setOperationNamespace(String)). The operation name is an optional parameter for the RFC, JDBC, and SOAP adapter; it is used in the logging of the Lookup API. Third party adapter may use this parameter.

Parameters:

aOperationName - operation name

setOperationNamespace

public void setOperationNamespace(String aOperationNamespace)

Sets the operation namespace. The default value is "". The operation namespace describes the payload together with the operation name ( setOperationName(String)). The operation namespace is an optional parameter for the RFC, JDBC, and SOAP adapter; it is used in the logging of the Lookup API. Third party adapter may use this parameter.

Parameters:

aOperationNamespace - the namespace of the operation

call

public Payload call(Payload payload)
             throws LookupException

Executes a lookup call. The method does not support transactional behaviour. Therefore, it should not be used to change the state in the accessed system; writing data to the accessed system can lead to inconsistencies. The method should only be used to read data from the accessed system.

Parameters:

payload - input payload

Returns:

payload resulting payload of the lookup.

Throws:

LookupException - if an error occurs.

NullPointerException - if payload is null.

close

public void close()
           throws LookupException

Closes this accessor and releases any resources associated with the accessor. Especially the returned input stream of the result payload is closed. Therefore, the parsing of the stream must be done before this method is called. Invoking of the call method is not allowed after this method has been invoced.

Throws:

LookupException - if an error occurs.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] SAP_XIAF	[sap.com] com.sap.aii.mapping.lib.facade	api	BC-XI