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
 void addDependency(String endpoint, String msg)
          Internal to DUCC.
 String getBroker()
           
 Map<String,String> getDependencies()
           
 String getEndpoint()
           
 ADuccId getId()
          This returns the Unique ID of the service as assigned by DUCC.
 ArrayList<ADuccId> getImplementors()
          This returns the set of DUCC Ids for all the service instances which implement this service.
 int getInstances()
          Internal to DUCC.
 org.apache.uima.ducc.transport.event.common.IDuccState.JobState getJobState()
           
 long getLinger()
          Internal to DUCC.
 IServiceStatistics getQstats()
           
 IServiceStatistics getQueueStatistics()
           
 ArrayList<ADuccId> getReferences()
           
 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()
          Get the owner of the service
 boolean isActive()
           
 boolean isDeregistered()
           
 boolean isStopped()
           
 void setActive(boolean active)
          Internal to DUCC.
 void setAutostart(boolean autostart)
          Internal to DUCC.
 void setBroker(String broker)
          Internal to DUCC.
 void setDeregistered(boolean d)
           
 void setEndpoint(String endpoint)
          Internal to DUCC.
 void setId(ADuccId id)
          Internal to DUCC.
 void setImplementors(ArrayList<ADuccId> implementors)
          Internal to DUCC.
 void setInstances(int instances)
           
 void setJobState(org.apache.uima.ducc.transport.event.common.IDuccState.JobState jobState)
          Internal to DUCC.
 void setLinger(long linger)
           
 void setQstats(IServiceStatistics qstats)
          Internal to DUCC.
 void setQueueStatistics(IServiceStatistics qstats)
          Internal to DUCC.
 void setReferences(ArrayList<ADuccId> references)
          Internal to DUCC.
 void setServiceState(org.apache.uima.ducc.transport.event.sm.IService.ServiceState serviceState)
          Internal to DUCC.
 void setStopped(boolean stopped)
          Internal to DUCC.
 void setSubclass(org.apache.uima.ducc.transport.event.sm.IService.ServiceClass subclass)
          Internal to DUCC.
 void setType(org.apache.uima.ducc.transport.event.sm.IService.ServiceType type)
          Internal to DUCC.
 void setUser(String u)
          Set the owner of the service
 

Method Detail

getId

ADuccId getId()
This returns the Unique ID of the service as assigned by DUCC.


setId

void setId(ADuccId id)
Internal to DUCC.


getUser

String getUser()
Get the owner of the service


setUser

void setUser(String u)
Set the owner of the service


getImplementors

ArrayList<ADuccId> 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.

setImplementors

void setImplementors(ArrayList<ADuccId> implementors)
Internal to DUCC.


getReferences

ArrayList<ADuccId> getReferences()

setReferences

void setReferences(ArrayList<ADuccId> references)
Internal to DUCC.


getType

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

setType

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


getSubclass

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

setSubclass

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


getEndpoint

String getEndpoint()

setEndpoint

void setEndpoint(String endpoint)
Internal to DUCC.


getBroker

String getBroker()

setBroker

void setBroker(String broker)
Internal to DUCC.


getServiceState

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

setServiceState

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


getJobState

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

setJobState

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


isActive

boolean isActive()

setActive

void setActive(boolean active)
Internal to DUCC.


setDeregistered

void setDeregistered(boolean d)

setQueueStatistics

void setQueueStatistics(IServiceStatistics qstats)
Internal to DUCC.


getQueueStatistics

IServiceStatistics getQueueStatistics()

setAutostart

void setAutostart(boolean autostart)
Internal to DUCC.


isStopped

boolean isStopped()

setStopped

void setStopped(boolean stopped)
Internal to DUCC.


getQstats

IServiceStatistics getQstats()

setQstats

void setQstats(IServiceStatistics qstats)
Internal to DUCC.


isDeregistered

boolean isDeregistered()

setInstances

void setInstances(int instances)

getInstances

int getInstances()
Internal to DUCC.


setLinger

void setLinger(long linger)

getLinger

long getLinger()
Internal to DUCC.


addDependency

void addDependency(String endpoint,
                   String msg)
Internal to DUCC.


getDependencies

Map<String,String> getDependencies()


Copyright © 2012–2014 The Apache Software Foundation. All rights reserved.