org.apache.uima.ducc.transport.event.sm

Interface IServiceDescription

All Superinterfaces:

org.apache.uima.ducc.transport.event.sm.IService, Serializable

public interface IServiceDescription
extends org.apache.uima.ducc.transport.event.sm.IService

This interface defines the information returned in response to service query events. All the 'set' methods are used only by the ServiceManager; they have useful no effect if invoked in any other context.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.uima.ducc.transport.event.sm.IService

org.apache.uima.ducc.transport.event.sm.IService.ServiceClass, org.apache.uima.ducc.transport.event.sm.IService.ServiceState, org.apache.uima.ducc.transport.event.sm.IService.ServiceType, org.apache.uima.ducc.transport.event.sm.IService.Trinary

Field Summary

Fields inherited from interface org.apache.uima.ducc.transport.event.sm.IService

NULL

Method Summary

Modifier and Type	Method and Description
void	addDependency(String endpoint, String msg)
String	getBroker()
Map<String,String>	getDependencies()
String	getDisableReason()
String	getEndpoint()
String	getErrorString()
Long	getId()
Long[]	getImplementors() This returns the set of DUCC Ids for all the service instances which implement this service.
Integer[]	getInstanceIds() This returns the list of contant instance ids for multi-instance services.
int	getInstances()
org.apache.uima.ducc.transport.event.common.IDuccState.JobState	getJobState()
long	getLastPing()
String	getLastPingString()
long	getLastRunnable()
String	getLastRunnableString()
long	getLastUse()
String	getLastUseString()
long	getLinger()
IServiceStatistics	getQstats()
IServiceStatistics	getQueueStatistics()
Long[]	getReferences()
String	getRegistrationDate()
org.apache.uima.ducc.transport.event.sm.IService.ServiceState	getServiceState()
org.apache.uima.ducc.transport.event.sm.IService.ServiceClass	getSubclass()
org.apache.uima.ducc.transport.event.sm.IService.ServiceType	getType()
String	getUser()
boolean	isActive()
boolean	isAutostart()
boolean	isDeregistered()
boolean	isEnabled()
boolean	isReferenceStart()
void	setActive(boolean active)
void	setAutostart(boolean autostart)
void	setBroker(String broker)
void	setDeregistered(boolean d)
void	setDisableReason(String r)
void	setEnabled(boolean enable)
void	setEndpoint(String endpoint)
void	setErrorString(String s)
void	setId(Long id)
void	setImplementors(ArrayList<Long> implementors, ArrayList<Integer> instancids)
void	setInstances(int instances)
void	setJobState(org.apache.uima.ducc.transport.event.common.IDuccState.JobState jobState)
void	setLastPing(long last_ping)
void	setLastRunnable(long last_runnable)
void	setLastUse(long last_use)
void	setLinger(long linger)
void	setQstats(IServiceStatistics qstats)
void	setQueueStatistics(IServiceStatistics qstats)
void	setReferences(ArrayList<Long> references)
void	setReferenceStart(boolean ref)
void	setRegistrationDate(String d)
void	setServiceState(org.apache.uima.ducc.transport.event.sm.IService.ServiceState serviceState)
void	setSubclass(org.apache.uima.ducc.transport.event.sm.IService.ServiceClass subclass)
void	setType(org.apache.uima.ducc.transport.event.sm.IService.ServiceType type)
void	setUser(String u)

Method Detail

getId

Long getId()

Returns:

the Unique ID of the service as assigned by DUCC.

setId

void setId(Long id)

getUser

String getUser()

Returns:

the owner of the service

setUser

void setUser(String u)

getImplementors

Long[] getImplementors()

This returns the set of DUCC Ids for all the service instances which implement this service. If the list is empty, no known implementors of the service are being managed by DUCC.

Returns:

List of DUCC Ids of service implementors. Parallel array with getInstanceIds().

getInstanceIds

Integer[] getInstanceIds()

This returns the list of contant instance ids for multi-instance services.

Returns:

List of service instance ids. Parallel array with getImplementors().

setImplementors

void setImplementors(ArrayList<Long> implementors,
                     ArrayList<Integer> instancids)

getReferences

Long[] getReferences()

setReferences

void setReferences(ArrayList<Long> references)

getType

org.apache.uima.ducc.transport.event.sm.IService.ServiceType getType()

setType

void setType(org.apache.uima.ducc.transport.event.sm.IService.ServiceType type)

getSubclass

org.apache.uima.ducc.transport.event.sm.IService.ServiceClass getSubclass()

setSubclass

void setSubclass(org.apache.uima.ducc.transport.event.sm.IService.ServiceClass subclass)

getEndpoint

String getEndpoint()

setEndpoint

void setEndpoint(String endpoint)

getBroker

String getBroker()

setBroker

void setBroker(String broker)

getServiceState

org.apache.uima.ducc.transport.event.sm.IService.ServiceState getServiceState()

setServiceState

void setServiceState(org.apache.uima.ducc.transport.event.sm.IService.ServiceState serviceState)

getJobState

org.apache.uima.ducc.transport.event.common.IDuccState.JobState getJobState()

setJobState

void setJobState(org.apache.uima.ducc.transport.event.common.IDuccState.JobState jobState)

isActive

boolean isActive()

setActive

void setActive(boolean active)

setDeregistered

void setDeregistered(boolean d)

setQueueStatistics

void setQueueStatistics(IServiceStatistics qstats)

getQueueStatistics

IServiceStatistics getQueueStatistics()

setAutostart

void setAutostart(boolean autostart)

isAutostart

boolean isAutostart()

setReferenceStart

void setReferenceStart(boolean ref)

isReferenceStart

boolean isReferenceStart()

isEnabled

boolean isEnabled()

setDisableReason

void setDisableReason(String r)

getDisableReason

String getDisableReason()

setLastUse

void setLastUse(long last_use)

getLastUse

long getLastUse()

getLastUseString

String getLastUseString()

setLastPing

void setLastPing(long last_ping)

getLastPing

long getLastPing()

getLastPingString

String getLastPingString()

setLastRunnable

void setLastRunnable(long last_runnable)

getLastRunnable

long getLastRunnable()

getLastRunnableString

String getLastRunnableString()

setRegistrationDate

void setRegistrationDate(String d)

getRegistrationDate

String getRegistrationDate()

getErrorString

String getErrorString()

setErrorString

void setErrorString(String s)

setEnabled

void setEnabled(boolean enable)

getQstats

IServiceStatistics getQstats()

setQstats

void setQstats(IServiceStatistics qstats)

isDeregistered

boolean isDeregistered()

setInstances

void setInstances(int instances)

getInstances

int getInstances()

setLinger

void setLinger(long linger)

getLinger

long getLinger()

addDependency

void addDependency(String endpoint,
                   String msg)

getDependencies

Map<String,String> getDependencies()