com.sapportals.wcm.protocol.ice.protocol

Class ICEContext

java.lang.Object
  com.sapportals.wcm.protocol.ice.protocol.ICEContext

public class ICEContext
extends Object

Stores context information about an ICE payload being parsed by an instance of ICEInput. The information comprises the elements at the beginning of an ICE payload (version, sender, ...) as well as the identifier of the currently processed request respective response. It can be used by subhandlers registered with ICEInput.

Note, that this information is collected gradually.

See Also:

ICEInput, IICEComRequestHandler, IICESynRequestHandler, IICESubRequestHandler, IICEResponseHandler, IICEExtensionRequestHandler,

Copyright 2004 SAP AG

Method Summary

static String	createID() Creates a new identifier which can be used by several elements in an ICE payload which need a unique identifier.
ICEInput	getInput() Gets the current instance of ICEInput parsing the incoming payload.
ICEOutput	getOutput() Gets the current instance of ICEOutput the requests or responses are written to.
String	getPayloadID() Gets the identifier of the incoming ICE payload.
Date	getPayloadTimestamp() Gets the timestamp of the incoming ICE payload.
String	getPayloadVersion() Gets the version number of the incoming ICE payload.
String	getRequestID() Gets the identifier of the current request.
String	getResponseID() Gets the identifier of the current response.
ICESender	getSender() Gets the information about the sender of the incoming ICE payload.
String	getUserAgent() Gets the name of the user agent found in the incoming ICE payload.

Methods inherited from class java.lang.Object

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

Method Detail

createID

public static String createID()

Creates a new identifier which can be used by several elements in an ICE payload which need a unique identifier. The identifier will be a concatenation of the current timestamp and the hostname of the server.

Returns:

a new identifier

getSender

public ICESender getSender()

Gets the information about the sender of the incoming ICE payload.

Returns:

an ICESender object containing the information about the sender

getInput

public ICEInput getInput()

Gets the current instance of ICEInput parsing the incoming payload.

Returns:

the current instance of ICEInput

getOutput

public ICEOutput getOutput()

Gets the current instance of ICEOutput the requests or responses are written to.

Returns:

the current instance of ICEOutput

getRequestID

public String getRequestID()

Gets the identifier of the current request.

Returns:

the identifier of the current request or null if there is none

getResponseID

public String getResponseID()

Gets the identifier of the current response.

Returns:

the identifier of the current response or null if there is none

getPayloadID

public String getPayloadID()

Gets the identifier of the incoming ICE payload.

Returns:

the identifier of the incoming payload

getPayloadVersion

public String getPayloadVersion()

Gets the version number of the incoming ICE payload.

Returns:

the version number of the incoming payload

getUserAgent

public String getUserAgent()

Gets the name of the user agent found in the incoming ICE payload.

Returns:

the name of the user agent or null if none is present

getPayloadTimestamp

public Date getPayloadTimestamp()

Gets the timestamp of the incoming ICE payload.

Returns:

a Date object representing the timestamp of the incoming payload

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM