*** This interface provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.events
Interface EventInterface

Deprecated. As of release 9.3, replaced by SAS Midtier Eventing Architecture.

@SASScope(value="ALL")
@BinaryCompatibilityOnly
public interface EventInterface

This interface represents an event that can be sent to an EventBroker service.

Usage

This interface is used to manipulate an Event that can ultimately be sent to a broker for processing.

Since:

1.0

Field Summary

static java.lang.String	ACK Deprecated. Response type: ack
static java.lang.String	NONE Deprecated. Response type: none
static java.lang.String	RESULT Deprecated. Response type: result
static int	SERIALIZE_FORMAT_DOCUMENT Deprecated. Serialize format: document
static int	SERIALIZE_FORMAT_STRING Deprecated. Serialize format: string

Method Summary

abstract java.lang.Object	getBody() Deprecated. Get body of this event.
abstract java.lang.String	getCredentialsDomain() Deprecated. Get authentication domain associated with this event sender's credentials.
abstract java.lang.String	getCredentialsName() Deprecated. Get credentials name.
abstract java.lang.String	getCredentialsPW() Deprecated. Get credentials password.
abstract java.lang.String	getCredentialsSessionContextId() Deprecated. Get session context id associated with this event sender's credentials.
abstract java.lang.String	getCredentialsSessionContextLockId() Deprecated. Get session context lock id associated with this event sender's credentials.
abstract java.lang.String	getFrom() Deprecated. Get event origination.
abstract java.lang.String	getIdentity() Deprecated. Get event identity.
abstract java.lang.String	getName() Deprecated. Get event name.
abstract int	getPriority() Deprecated. Get event priority.
abstract java.util.Map	getProperties() Deprecated. Get properties associated with this event.
abstract java.lang.String	getResponseType() Deprecated. Get the response type associated with this event.
abstract java.lang.String	getTime() Deprecated. Get date/time stamp set for this event.
abstract double	getVersion() Deprecated. Get event version.
abstract java.lang.Object	serialize(int format) Deprecated. Serialize this event into the specified format so that it can be sent to a broker for processing.
abstract void	setBody(org.w3c.dom.Node node) Deprecated. Set body for this event.
abstract void	setBody(java.lang.String body) Deprecated. Set body for this event.
abstract void	setCredentials(java.lang.String sessionContextId, java.lang.String sessionContextLockId) Deprecated. Set credentials.
abstract void	setCredentials(java.lang.String name, java.lang.String password, java.lang.String domain) Deprecated. Set credentials.
abstract void	setFrom(java.lang.String from) Deprecated. Set event origination.
abstract void	setIdentity(java.lang.String identity) Deprecated. Set event identity.
abstract void	setName(java.lang.String eventName) Deprecated. Set event name.
abstract void	setPriority(int priority) Deprecated. Set event priority.
abstract void	setProperties(java.util.Map map) Deprecated. Set properties to be associated with this event.
abstract void	setResponseType(java.lang.String responseType) Deprecated. Set the response type that is desired.
abstract void	setTime(java.lang.String time) Deprecated. Set a date/time stamp for this event.
abstract void	setVersion(double version) Deprecated. Set event version.

Field Detail

SERIALIZE_FORMAT_STRING

static final int SERIALIZE_FORMAT_STRING

Deprecated.

Serialize format: string

See Also:

Constant Field Values

SERIALIZE_FORMAT_DOCUMENT

static final int SERIALIZE_FORMAT_DOCUMENT

Deprecated.

Serialize format: document

See Also:

Constant Field Values

NONE

static final java.lang.String NONE

Deprecated.

Response type: none

See Also:

Constant Field Values

ACK

static final java.lang.String ACK

Deprecated.

Response type: ack

See Also:

Constant Field Values

RESULT

static final java.lang.String RESULT

Deprecated.

Response type: result

See Also:

Constant Field Values

Method Detail

setName

void setName(java.lang.String eventName)

Deprecated.

Set event name.

Parameters:

eventName - Event name.

getName

java.lang.String getName()

Deprecated.

Get event name.

Returns:

name of event.

setVersion

void setVersion(double version)

Deprecated.

Set event version.

Parameters:

version - Event version.

getVersion

double getVersion()

Deprecated.

Get event version.

Returns:

version of event.

setIdentity

void setIdentity(java.lang.String identity)

Deprecated.

Set event identity.

Parameters:

identity - Event identity.

getIdentity

java.lang.String getIdentity()

Deprecated.

Get event identity.

Returns:

identity of event.

setCredentials

void setCredentials(java.lang.String name,
                    java.lang.String password,
                    java.lang.String domain)

Deprecated.

Set credentials.

Parameters:

name - Name of principal sending the event.

password - Password of principal sending the event.

domain - Authentication domain associated with this principal.

setCredentials

void setCredentials(java.lang.String sessionContextId,
                    java.lang.String sessionContextLockId)

Deprecated.

Set credentials.

An alternative to using name, password, and domain. Allows the sender of an event to specify a session context that is bound to an already authenticated user context.

Parameters:

sessionContextId - session context id associated with authenticated user context.

sessionContextLockId - lock on the session context if applicable.

getCredentialsName

java.lang.String getCredentialsName()

Deprecated.

Get credentials name.

Returns:

name of principal sending the event.

getCredentialsPW

java.lang.String getCredentialsPW()

Deprecated.

Get credentials password.

Returns:

password of principal sending the event.

getCredentialsDomain

java.lang.String getCredentialsDomain()

Deprecated.

Get authentication domain associated with this event sender's credentials.

Returns:

authentication domain associated with the sender of this event.

getCredentialsSessionContextId

java.lang.String getCredentialsSessionContextId()

Deprecated.

Get session context id associated with this event sender's credentials.

Returns:

session context id associated with the sender of this event.

getCredentialsSessionContextLockId

java.lang.String getCredentialsSessionContextLockId()

Deprecated.

Get session context lock id associated with this event sender's credentials.

Returns:

session context lock id associated with the sender of this event.

setPriority

void setPriority(int priority)

Deprecated.

Set event priority.

Setting a priority does not change the processing order of incoming events. It simply sets the Java thread priority that the broker processing thread runs as. Valid values are between java.lang.Thread.MIN_PRIORITY and java.lang.Thread.MAX_PRIORITY.

Parameters:

priority - Event priority.

getPriority

int getPriority()

Deprecated.

Get event priority.

Returns:

priority of event.

setFrom

void setFrom(java.lang.String from)

Deprecated.

Set event origination.

Can include "who/where" descriptive information that describes the event origination.

Parameters:

from - information that describes where the event originated from.

getFrom

java.lang.String getFrom()

Deprecated.

Get event origination.

Returns:

information that describes where the event originated from.

setTime

void setTime(java.lang.String time)

Deprecated.

Set a date/time stamp for this event.

If a date/time is not set for this event, it will automatically be generated during serialization.

Parameters:

time - date/time GMT.

getTime

java.lang.String getTime()

Deprecated.

Get date/time stamp set for this event.

Returns:

date/time GMT.

setResponseType

void setResponseType(java.lang.String responseType)

Deprecated.

Set the response type that is desired. The default response type is assumed "none".

Valid types are as follows:

• NONE
• ACK
• RESULT

Parameters:

responseType - Type of response to be generated by broker.

getResponseType

java.lang.String getResponseType()

Deprecated.

Get the response type associated with this event.

Returns:

type of response that is requested for this event.

setProperties

void setProperties(java.util.Map map)

Deprecated.

Set properties to be associated with this event.

To apply namespaces to individual properties, prefix the name of the property with its desired namespace followed by a : (semi-colon) character.

Parameters:

map - name/value pairs.

getProperties

java.util.Map getProperties()

Deprecated.

Get properties associated with this event.

Returns:

properties associated with this event.

setBody

void setBody(java.lang.String body)

Deprecated.

Set body for this event.

Parameters:

body - application body for this event.

setBody

void setBody(org.w3c.dom.Node node)

Deprecated.

Set body for this event.

Node must be one of the following types:

• Document
• DocumentFragment
• Element

Parameters:

node - application body for this event.

getBody

java.lang.Object getBody()

Deprecated.

Get body of this event.

Returns:

body of this event.

serialize

java.lang.Object serialize(int format)

Deprecated.

Serialize this event into the specified format so that it can be sent to a broker for processing. Supported formats are listed below.

• String
• Document

Parameters:

format - Serialize format.

Returns:

serialized object or null if serialization fails.

*** This interface provides Binary Compatibility only, not Source Compatibility ***