org.opensaml.profile.context

Class EventContext<EventType>

java.lang.Object

org.opensaml.messaging.context.BaseContext

org.opensaml.profile.context.EventContext<EventType>

Type Parameters:

EventType - the event type of the context

All Implemented Interfaces:

Iterable<BaseContext>

Direct Known Subclasses:

PreviousEventContext

public class EventContext<EventType>
extends BaseContext

A context component which holds the result of a profile action that produces an "event".

Actions that operate on contexts and want to signal the result in the form of an "event" to a sibling or parent component can create or modify an EventContext. The context contains a generic type that represents an event of meaning to a surrounding processing model, such as a workflow.

Nested Class Summary

Nested classes/interfaces inherited from class org.opensaml.messaging.context.BaseContext

BaseContext.ContextSetNoRemoveIteratorDecorator

Field Summary

Fields

Modifier and Type	Field and Description
private EventType	event The event represented.

Constructor Summary

Constructors

Constructor and Description
EventContext()

Method Summary

Methods

Modifier and Type	Method and Description
EventType	getEvent() Get the event represented by the context.
EventContext	setEvent(EventType newEvent) Set the event represented by the context.

Methods inherited from class org.opensaml.messaging.context.BaseContext

addSubcontext, addSubcontext, clearSubcontexts, containsSubcontext, createSubcontext, getParent, getSubcontext, getSubcontext, getSubcontext, getSubcontext, isAutoCreateSubcontexts, iterator, removeSubcontext, removeSubcontext, setAutoCreateSubcontexts, setParent

Methods inherited from class java.lang.Object

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

Field Detail

event

private EventType event

The event represented.

Constructor Detail

EventContext

public EventContext()

Method Detail

getEvent

@Nullable
public EventType getEvent()

Get the event represented by the context.

Returns:

the event

setEvent

@Nonnull
public EventContext setEvent(@Nullable
                            EventType newEvent)

Set the event represented by the context.

Parameters:

newEvent - the event

Returns:

this context