|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.corona.collaboration.CollaborationEvent
public class CollaborationEvent
Collaboration Events are a specialized OSGi Event. A Collaboration Event must be able to be serialized so that it can be shared within a distributed collaboration environment.
Field Summary | |
---|---|
protected java.util.Hashtable |
dictionary
|
Fields inherited from interface org.eclipse.corona.collaboration.ICollaborationEvent |
---|
ACTION_TYPE, COLLABORATION_ID, CONTEXT_NAME, CONTEXT_TYPE, CONTEXT_URI, REMOTE_URI, RESOURCE_CONTAINER_URI, RESOURCE_NAME, RESOURCE_PROPERTY_CONTACT, RESOURCE_PROPERTY_DESCRIPTION, RESOURCE_PROPERTY_OBJECTIVE, RESOURCE_PROPERTY_PROJECT_LEADER, RESOURCE_PROPERTY_START, RESOURCE_PROPERTY_STATUS, RESOURCE_PROPERTY_TYPE, RESOURCE_PROPERTY_URI, RESOURCE_PROPERTY_VALUE, RESOURCE_TYPE, RESOURCE_URI, ROUTER_ID, TOPIC_ROOT, TOPIC_SEPARATOR |
Fields inherited from interface org.osgi.service.event.EventConstants |
---|
BUNDLE_SIGNER, BUNDLE_SYMBOLICNAME, EVENT, EVENT_FILTER, EVENT_TOPIC, EXCEPTION, EXCEPTION_CLASS, EXCEPTION_MESSAGE, EXECPTION_CLASS, MESSAGE, SERVICE, SERVICE_ID, SERVICE_OBJECTCLASS, SERVICE_PID, TIMESTAMP |
Constructor Summary | |
---|---|
CollaborationEvent(org.osgi.service.event.Event event)
Construct a new Collaboration Event. |
|
CollaborationEvent(java.lang.String ctxURI,
java.lang.String ctxType,
java.lang.String ctxName)
Construct a new Collaboration Event. |
|
CollaborationEvent(java.lang.String ctxURI,
java.lang.String ctxType,
java.lang.String ctxName,
java.util.Dictionary properties)
Construct a new Collaboration Event. |
Method Summary | |
---|---|
void |
addRemoteURI(java.lang.String uri)
Add a remote URI that this event should be routed to. |
static CollaborationEvent |
createCollaborationEvent(org.osgi.service.event.Event osgiEvent)
Create a Collaboration Event for an OSGi event |
void |
defineBundleProperties(org.osgi.framework.Bundle bundle)
Define the event properties associated with a Bundle |
void |
defineExceptionProperties(java.lang.Throwable t)
Define the event properties associated with an Exception |
void |
defineProperty(java.lang.String key,
java.lang.Object value)
Define a Collaboration Event property. |
void |
defineServiceReferenceProperties(org.osgi.framework.ServiceReference ref)
Define the event properties associated with a service |
java.lang.String |
getActionType()
|
java.lang.Object |
getAdapter(java.lang.Class adapter)
Eclipse IAdaptable extension-point |
java.lang.String |
getCollaborationID()
Get the ID of the artifact that is the subject of collaboration |
java.lang.String |
getContextName()
|
java.lang.String |
getContextType()
Get the context type specifies the type of event. |
java.lang.String |
getContextURI()
Get the URI that defines the context of this event. |
org.osgi.service.event.Event |
getEvent()
Get the OSGi Event that represents this Collaboration Event. |
java.lang.Object |
getProperty(java.lang.String name)
Retrieves a property. |
java.lang.String |
getPropertyAsString(java.lang.String name)
|
java.lang.String[] |
getPropertyNames()
Returns a list of this event's property names. |
java.lang.String |
getTopic()
Get the collaboration topic used to distribute this event |
java.net.URI[] |
listRemoteURIs(java.lang.String uriScheme)
Get the list of remote URIs where the CollaborationEvent should be routed to. |
void |
setActionType(java.lang.String actionType)
|
void |
setCollaborationID(java.lang.String id)
Set the ID of the artifact that is the subject of collaboration |
java.lang.String |
toString()
dump the contents of the event |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected java.util.Hashtable dictionary
Constructor Detail |
---|
public CollaborationEvent(org.osgi.service.event.Event event)
event
- is the OSGi event to convert to a Collaboration Eventpublic CollaborationEvent(java.lang.String ctxURI, java.lang.String ctxType, java.lang.String ctxName)
ctxURI
- is URI of the collaboration contextctxType
- is the type of context that defines the collaboration scopectxName
- is the unique name for collaborating within its CONTEXT_TYPEpublic CollaborationEvent(java.lang.String ctxURI, java.lang.String ctxType, java.lang.String ctxName, java.util.Dictionary properties)
ctxURI
- is URI of the collaboration contextctxType
- is the type of context that defines the collaboration scopectxName
- is the unique name for collaborating within its CONTEXT_TYPEMethod Detail |
---|
public static CollaborationEvent createCollaborationEvent(org.osgi.service.event.Event osgiEvent)
osgiEvent
-
public void defineProperty(java.lang.String key, java.lang.Object value)
key
- that uniquely identifies the propertyvalue
- of the property being definedpublic void defineBundleProperties(org.osgi.framework.Bundle bundle)
bundle
- public void defineExceptionProperties(java.lang.Throwable t)
t
- public void defineServiceReferenceProperties(org.osgi.framework.ServiceReference ref)
properties
- ref
- public org.osgi.service.event.Event getEvent()
public final java.lang.Object getProperty(java.lang.String name)
name
- the name of the property to retrieve
null
if not found.public final java.lang.String getPropertyAsString(java.lang.String name)
public final java.lang.String[] getPropertyNames()
public java.lang.Object getAdapter(java.lang.Class adapter)
getAdapter
in interface org.eclipse.core.runtime.IAdaptable
adapter
-
IAdaptable.getAdapter(Class)
public java.lang.String getTopic()
public java.lang.String getCollaborationID()
public void setCollaborationID(java.lang.String id)
id
- unique identifierpublic void addRemoteURI(java.lang.String uri)
public java.net.URI[] listRemoteURIs(java.lang.String uriScheme)
public java.lang.String getContextURI()
ICollaborationEvent
getContextURI
in interface ICollaborationEvent
ICollaborationEvent.getContextURI()
public java.lang.String getContextType()
ICollaborationEvent
getContextType
in interface ICollaborationEvent
ICollaborationEvent.getContextType()
public java.lang.String getContextName()
getContextName
in interface ICollaborationEvent
ICollaborationEvent.getContextName()
public java.lang.String getActionType()
getActionType
in interface ICollaborationEvent
public void setActionType(java.lang.String actionType)
setActionType
in interface ICollaborationEvent
public java.lang.String toString()
toString
in class java.lang.Object
|
Copyright 2006 IBM Corporation and others. All Rights Reserved. |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |