public interface ComponentReference extends EndpointReference
Title: Service Event Fabric Core
Description: Defines a Component reference.
Copyright: Copyright (c) 2010
Company: StreamScape Technologies
Modifier and Type | Method and Description |
---|---|
java.util.List |
getAccessors(EventScope eventScope)
Returns the list of accessors with the specified event scope.
|
java.util.List |
getAccessorSessions(EventScope eventScope)
Returns the list of accessor sessions with the specified event scope.
|
java.util.List |
getAsyncConsumers(EventScope eventScope)
Returns a list of the async consumers with the specified event scope.
|
java.util.List |
getAsyncConsumers(java.lang.String groupName)
Returns a list of the async consumers which belong to the specified group.
|
java.util.List |
getConsumers(EventScope eventScope)
Returns a list of the consumers with the specified event scope.
|
java.lang.String |
getDescription()
Returns a description of the component.
|
java.util.List |
getDirectConsumers(EventScope eventScope)
Returns a list of the direct consumers with the specified event scope.
|
java.util.List |
getEventConsumers(EventScope eventScope)
Returns a list of the event consumers (direct, async and receivers) with the specified event scope.
|
java.util.List |
getEventConsumers(java.lang.String groupName)
Returns a list of all event consumers (async and receivers) which belong to the specified group.
|
ExceptionStrategy |
getExceptionStrategy()
Returns an exception strategy of the component.
|
ComponentModel |
getModel()
Returns a model of the component.
|
java.lang.String |
getName()
Return a name of the component.
|
java.lang.String |
getOwnerName()
Returns a name of the user (or group) owning this component.
|
java.util.List |
getReceivers(EventScope eventScope)
Returns a list of the receivers with the specified event scope.
|
java.util.List |
getReceivers(java.lang.String groupName)
Returns a list of the receivers which belong to the specified group.
|
java.util.List |
getReplicationSources()
Returns the list of replication sources.
|
java.util.List |
getReplicationTargets()
Returns the list of replication targets.
|
java.util.List |
getRequestConsumers(EventScope eventScope)
Returns a list of the request consumers with the specified event scope.
|
SecurityContext |
getSecurityContext()
Returns a Security Context associated with the user owning this component.
|
long |
getTimestamp()
Returns a timestamp indicating when the component was created.
|
boolean |
hasBoundEventIds()
Checks if the component has event ids bound to it.
|
boolean |
isBoundEventId(java.lang.String eventId)
Checks if the specified event identifier is bound to the component.
|
boolean |
isGroupMember(java.lang.String groupName)
Checks if the component has joined the specified group.
|
java.util.List |
listAccessors()
Returns the list of names of all accessors.
|
java.util.List |
listAccessorSessions()
Returns the list of names of all accessor sessions.
|
java.util.List |
listAsyncConsumers()
Returns a list of the names of all async consumers.
|
java.util.List |
listBoundEventIds()
Returns a list of event identifiers bound to the component.
|
java.util.List |
listConsumers()
Returns the list of names of all consumers (direct, async, request consumers and receivers).
|
java.util.List |
listDirectConsumers()
Returns a list of the names of all async consumers.
|
java.util.List |
listEventConsumers()
Returns a list of the names of all event consumers (direct, async consumer and receivers).
|
java.util.List |
listGroups()
Returns a list of the names of all groups to which the component has joined.
|
java.util.List |
listReceivers()
Returns a list of the names of all receivers or the empty list if the component has no receivers.
|
java.util.List |
listReplicationSources()
Returns a list of the names of all replication sources or the empty list if the component has no replication sources.
|
java.util.List |
listReplicationTargets()
Returns a list of the names of all replication targets or the empty list if the component has no replication targets.
|
java.util.List |
listRequestConsumers()
Returns ta list of the names of all request consumers.
|
AccessorReference |
lookupAccessor(java.lang.String name)
Returns the accessor with the specified name.
|
AccessorSessionReference |
lookupAccessorSession(FabricAddress address)
Returns the accessor session with the specified Fabric address.
|
AccessorSessionReference |
lookupAccessorSession(java.lang.String name)
Returns the accessor session with the specified name.
|
AsyncConsumerReference |
lookupAsyncConsumer(FabricAddress address)
Returns the async consumer with the specified Fabric address.
|
AsyncConsumerReference |
lookupAsyncConsumer(java.lang.String name)
Returns the async consumer with the specified name.
|
ConsumerReference |
lookupConsumer(FabricAddress address)
Returns the consumer with the specified Fabric address.
|
ConsumerReference |
lookupConsumer(java.lang.String name)
Returns the consumer with the specified name.
|
DirectConsumerReference |
lookupDirectConsumer(FabricAddress address)
Returns the direct consumer with the specified Fabric address.
|
DirectConsumerReference |
lookupDirectConsumer(java.lang.String name)
Returns the direct consumer with the specified name.
|
EventConsumerReference |
lookupEventConsumer(FabricAddress address)
Returns the event consumer (direct or async consumer or receiver) with the specified Fabric address.
|
EventConsumerReference |
lookupEventConsumer(java.lang.String name)
Returns the event consumer (direct or async consumer or receiver) with the specified name.
|
ReceiverReference |
lookupReceiver(FabricAddress address)
Returns the receiver with the specified Fabric address.
|
ReceiverReference |
lookupReceiver(java.lang.String name)
Returns the receiver with the specified name.
|
ReplicationSourceReference |
lookupReplicationSource(java.lang.String name)
Returns the replication source with the specified name.
|
ReplicationTargetReference |
lookupReplicationTarget(java.lang.String name)
Returns the replication target with the specified name.
|
RequestConsumerReference |
lookupRequestConsumer(FabricAddress address)
Returns the request consumer with the specified Fabric address.
|
RequestConsumerReference |
lookupRequestConsumer(java.lang.String name)
Returns the request consumer with the specified name.
|
getAddress
getComponentAddress, getEventScope, getExchangeRole
java.lang.String getName()
getName
in interface NamedObject
java.lang.String getDescription()
ComponentModel getModel()
long getTimestamp()
java.lang.String getOwnerName()
SecurityContext getSecurityContext()
null
if a security is disabled in the Fabric or
this component does not belong to the current node.boolean hasBoundEventIds()
true
if the component has the bound event ids, false
otherwise.boolean isBoundEventId(java.lang.String eventId)
eventId
- eventId the event id to be checked.true
if the event id is bound to the component, false
otherwise.java.util.List listBoundEventIds()
ExceptionStrategy getExceptionStrategy()
EventConsumer
)
during a processing of events raised by the component.java.util.List getConsumers(EventScope eventScope)
null
or INHERITED
, the list of all consumers will be returned.
If the event scope LOCAL
is specified, the empty list will be returned.eventScope
- the event scope of consumers which are to be found.java.util.List getEventConsumers(EventScope eventScope)
null
or INHERITED
, the list of all event consumers will be returned.
If the event scope LOCAL
is specified, the empty list will be returned.eventScope
- the event scope of consumers which are to be found.java.util.List getDirectConsumers(EventScope eventScope)
null
or INHERITED
, the list of all direct consumers will be returned.
If the event scope LOCAL
is specified, the empty list will be returned.eventScope
- the event scope of direct consumers which are to be found.java.util.List getAsyncConsumers(EventScope eventScope)
null
or INHERITED
, the list of all async consumers will be returned.
If the event scope LOCAL
is specified, the empty list will be returned.eventScope
- the event scope of async consumers which are to be found.java.util.List getRequestConsumers(EventScope eventScope)
null
or INHERITED
, the list of all request consumers will be returned.
If the event scope LOCAL
is specified, the empty list will be returned.eventScope
- the event scope of request consumers which are to be found.java.util.List getReceivers(EventScope eventScope)
null
or INHERITED
, the list of all receivers will be returned.
If the event scope LOCAL
is specified, the empty list will be returned.eventScope
- the event scope of receivers which are to be found.java.util.List getAccessors(EventScope eventScope)
null
or INHERITED
, the list of all accessors will be returned.
LOCAL
is specified, the empty list will be returned.eventScope
- the event scope of accessors which are to be found.java.util.List getAccessorSessions(EventScope eventScope)
null
or INHERITED
, the list of all accessor sessions will be returned.
LOCAL
is specified, the empty list will be returned.eventScope
- the event scope of accessor sessions which are to be found.java.util.List getReplicationSources()
java.util.List getReplicationTargets()
java.util.List getEventConsumers(java.lang.String groupName)
groupName
- the name of the specified group.java.util.List getAsyncConsumers(java.lang.String groupName)
groupName
- the name of the specified group.java.util.List getReceivers(java.lang.String groupName)
groupName
- the name of the specified group.ConsumerReference lookupConsumer(FabricAddress address)
address
- the Fabric address of consumer which is to be found.null
if the consumer is not found.ConsumerReference lookupConsumer(java.lang.String name)
name
- the name of consumer which is to be found.null
if the consumer is not found.EventConsumerReference lookupEventConsumer(FabricAddress address)
address
- the Fabric address of event consumer which is to be found.null
if the consumer is not found.EventConsumerReference lookupEventConsumer(java.lang.String name)
name
- the name of event consumer which is to be found.null
if the consumer is not found.DirectConsumerReference lookupDirectConsumer(FabricAddress address)
address
- the Fabric address of direct consumer which is to be found.null
if the consumer is not found.DirectConsumerReference lookupDirectConsumer(java.lang.String name)
name
- the name of direct consumer which is to be found.null
if the consumer is not found.AsyncConsumerReference lookupAsyncConsumer(FabricAddress address)
address
- the Fabric address of async consumer which is to be found.null
if the consumer is not found.AsyncConsumerReference lookupAsyncConsumer(java.lang.String name)
name
- the name of async consumer which is to be found.null
if the consumer is not found.RequestConsumerReference lookupRequestConsumer(FabricAddress address)
address
- the Fabric address of request consumer which is to be found.null
if the consumer is not found.RequestConsumerReference lookupRequestConsumer(java.lang.String name)
name
- the name of request consumer which is to be found.null
if the consumer is not found.ReceiverReference lookupReceiver(FabricAddress address)
address
- the Fabric address of receiver which is to be found.null
if the receiver is not found.ReceiverReference lookupReceiver(java.lang.String name)
name
- the name of receiver which is to be found.null
if the receiver is not found.ReplicationSourceReference lookupReplicationSource(java.lang.String name)
name
- the name of replication source which is to be found.null
if replication source is not found.ReplicationTargetReference lookupReplicationTarget(java.lang.String name)
name
- the name of replication target which is to be found.null
if replication target is not found.AccessorReference lookupAccessor(java.lang.String name)
name
- the name of accessor which is to be found.null
if the accessor is not found.AccessorSessionReference lookupAccessorSession(FabricAddress address)
address
- the Fabric address of accessor session which is to be found.null
if the session is not found.AccessorSessionReference lookupAccessorSession(java.lang.String name)
name
- the name of accessor session which is to be found.null
if the session is not found.java.util.List listConsumers()
java.util.List listEventConsumers()
java.util.List listDirectConsumers()
java.util.List listAsyncConsumers()
java.util.List listRequestConsumers()
java.util.List listReceivers()
java.util.List listReplicationSources()
java.util.List listReplicationTargets()
java.util.List listAccessors()
java.util.List listAccessorSessions()
boolean isGroupMember(java.lang.String groupName)
groupName
- the name of the specified group.true
if the component has joined the specified group, false
otherwise.java.util.List listGroups()
Copyright © 2015-2024 StreamScape Technologies. All rights reserved.