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

com.sas.services.events
Interface EventInterface

All Known Implementing Classes:

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 String	ACK Response type: ack
static String	NONE Response type: none
static String	RESULT Response type: result
static int	SERIALIZE_FORMAT_DOCUMENT Serialize format: document
static int	SERIALIZE_FORMAT_STRING Serialize format: string

Method Summary

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

Field Detail

SERIALIZE_FORMAT_STRING

public static final int SERIALIZE_FORMAT_STRING

Serialize format: string

SERIALIZE_FORMAT_DOCUMENT

public static final int SERIALIZE_FORMAT_DOCUMENT

Serialize format: document

NONE

public static final String NONE

Response type: none

ACK

public static final String ACK

Response type: ack

RESULT

public static final String RESULT

Response type: result

Method Detail

setName

public void setName(String eventName)

Set event name.

Parameters:

eventName - Event name.

getName

public String getName()

Get event name.

Returns:

name of event.

setVersion

public void setVersion(double version)

Set event version.

Parameters:

version - Event version.

getVersion

public double getVersion()

Get event version.

Returns:

version of event.

setIdentity

public void setIdentity(String identity)

Set event identity.

Parameters:

identity - Event identity.

getIdentity

public String getIdentity()

Get event identity.

Returns:

identity of event.

setCredentials

public void setCredentials(String name,
                           String password,
                           String domain)

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

public void setCredentials(String sessionContextId,
                           String sessionContextLockId)

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

public String getCredentialsName()

Get credentials name.

Returns:

name of principal sending the event.

getCredentialsPW

public String getCredentialsPW()

Get credentials password.

Returns:

password of principal sending the event.

getCredentialsDomain

public String getCredentialsDomain()

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

Returns:

authentication domain associated with the sender of this event.

getCredentialsSessionContextId

public String getCredentialsSessionContextId()

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

Returns:

session context id associated with the sender of this event.

getCredentialsSessionContextLockId

public String getCredentialsSessionContextLockId()

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

public void setPriority(int priority)

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

public int getPriority()

Get event priority.

Returns:

priority of event.

setFrom

public void setFrom(String from)

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

public String getFrom()

Get event origination.

Returns:

information that describes where the event originated from.

setTime

public void setTime(String time)

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

public String getTime()

Get date/time stamp set for this event.

Returns:

date/time GMT.

setResponseType

public void setResponseType(String responseType)

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

public String getResponseType()

Get the response type associated with this event.

Returns:

type of response that is requested for this event.

setProperties

public void setProperties(Map map)

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

public Map getProperties()

Get properties associated with this event.

Returns:

properties associated with this event.

setBody

public void setBody(String body)

Set body for this event.

Parameters:

body - application body for this event.

setBody

public void setBody(Node node)

Set body for this event.

Node must be one of the following types:

• Document
• DocumentFragment
• Element

Parameters:

node - application body for this event.

getBody

public Object getBody()

Get body of this event.

Returns:

body of this event.

serialize

public Object serialize(int format)

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 API provides Binary Compatibility only, not Source Compatibility ***