|
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ServiceContext
Provides functionality that the service will require throughout its lifetime. This object will be passed to a service instance when it is created. The service instance may choose to cache a reference to this object and call on it any time it is required.
ServiceContainer.onCreateService(com.platform.symphony.soam.ServiceContext)
Method Summary | |
---|---|
java.lang.String |
getApplicationName()
Gets the name of the application. |
java.lang.String |
getConsumerId()
Gets the consumer ID. |
java.lang.String |
getDeployDirectory()
Gets the deployment directory. |
InterruptEvent |
getLastInterruptEvent()
Gets the current interrupt event. |
java.lang.String |
getLogDirectory()
Gets the log directory. |
java.lang.String |
getServiceName()
Gets the service name. |
ServiceToSlotRatio |
getServiceToSlotRatio()
Gets the service to slot ratio for this service instance, which indicates how many slots this service is consuming. |
void |
publish(ResourceAttribute attribute)
Publishes the attribute to the system. |
void |
publish(ResourceAttribute attribute,
boolean throwOnFailure)
Publishes the attribute to the system. |
void |
setControlCode(int code)
Sets a service control code for service instance manager. |
void |
unpublish(ResourceAttribute attribute)
"Un-Publishes" the attribute from the system. |
void |
unpublish(ResourceAttribute attribute,
boolean throwOnFailure)
"Un-Publishes" the attribute from the system. |
Method Detail |
---|
java.lang.String getServiceName() throws SoamException
SoamException
InterruptEvent getLastInterruptEvent() throws SoamException
SoamException
InterruptEvent
void setControlCode(int code) throws SoamException
code
- The control code defined in the Application Profile
SoamException
java.lang.String getApplicationName() throws SoamException
SoamException
java.lang.String getConsumerId() throws SoamException
SoamException
java.lang.String getDeployDirectory() throws SoamException
SoamException
java.lang.String getLogDirectory() throws SoamException
SoamException
ServiceToSlotRatio getServiceToSlotRatio() throws SoamException
SoamException
void publish(ResourceAttribute attribute) throws SoamException
attribute
- The attribute being published.
SoamException
ResourceAttribute
void publish(ResourceAttribute attribute, boolean throwOnFailure) throws SoamException
attribute
- The attribute being published.throwOnFailure
- Indicates whether we want the method to throw an
exception if it fails to publish the attribute.
SoamException
ResourceAttribute
void unpublish(ResourceAttribute attribute) throws SoamException
attribute
- The attribute being "un-published".
SoamException
ResourceAttribute
void unpublish(ResourceAttribute attribute, boolean throwOnFailure) throws SoamException
attribute
- The attribute being un-published.throwOnFailure
- Indicates whether we want the method to throw an
exception if it fails to "un-publish" the attribute.
SoamException
ResourceAttribute
|
Version 5.0 Date Modified: -DREL_DATE=Nov 11 2009 Platform Computing. Accelerating Intelligence(TM). Copyright (C) 2001-2009 Platform Computing Corporation. All rights reserved. |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |