Package org.opencastproject.serviceregistry.api

Class ServiceRegistrationInMemoryImpl

java.lang.Object

org.opencastproject.serviceregistry.api.ServiceRegistrationInMemoryImpl

All Implemented Interfaces:

ServiceRegistration

public class ServiceRegistrationInMemoryImpl
extends Object
implements ServiceRegistration

Simple implementation of a service registration.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	host	Host that is running the service
protected boolean	isActive	True if this service is active
protected boolean	isInMaintenanceMode	True if this service in in maintenance mode
protected boolean	isJobProducer	True if this service produces jobs
protected boolean	isOnline	True if this service is online
protected String	path	Path to the service
protected JobProducer	service	The service instance
protected String	serviceType	Service type

Constructor Summary

Constructors

Constructor	Description
ServiceRegistrationInMemoryImpl(String type, String host, String path, boolean jobProducer)	Creates a new service registration.
ServiceRegistrationInMemoryImpl(JobProducer service, String host)	Creates a new service registration.

Method Summary

Modifier and Type	Method	Description
int	getErrorStateTrigger()	Gets the job signature which changed last time the service state to error.
String	getHost()
Date	getOnlineFrom()	Gets the last time the service has been declared online
String	getPath()
JobProducer	getService()	Returns the actual service instance.
ServiceState	getServiceState()	Gets the current state of the service
String	getServiceType()
Date	getStateChanged()	Gets the last date when state was changed
int	getWarningStateTrigger()	Gets the job signature which changed last time the service state to warning
boolean	isActive()
boolean	isInMaintenanceMode()	Whether the service is in maintenance mode.
boolean	isJobProducer()
boolean	isOnline()
void	setMaintenance(boolean maintenance)	Sets the service's maintenance mode.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

serviceType

protected String serviceType

Service type

host

protected String host

Host that is running the service

path

protected String path

Path to the service

service

protected JobProducer service

The service instance

isJobProducer

protected boolean isJobProducer

True if this service produces jobs

isActive

protected boolean isActive

True if this service is active

isOnline

protected boolean isOnline

True if this service is online

isInMaintenanceMode

protected boolean isInMaintenanceMode

True if this service in in maintenance mode

Constructor Details

ServiceRegistrationInMemoryImpl

public ServiceRegistrationInMemoryImpl(String type,
 String host,
 String path,
 boolean jobProducer)

Creates a new service registration. The service is initially online and not in maintenance mode.

Parameters:

type - the service type

host - the service host

path - the path to the service

jobProducer - true if the service is a job producer

ServiceRegistrationInMemoryImpl

public ServiceRegistrationInMemoryImpl(JobProducer service,
 String host)

Creates a new service registration. The service is initially online and not in maintenance mode.

Parameters:

service - the local service instance

host - the host that the service is running on

Method Details

getServiceType

public String getServiceType()

Specified by:

getServiceType in interface ServiceRegistration

Returns:

the type of service

See Also:

• ServiceRegistration.getServiceType()

getHost

public String getHost()

Specified by:

getHost in interface ServiceRegistration

Returns:

the host providing the service endpoint.

See Also:

• ServiceRegistration.getHost()

getPath

public String getPath()

Specified by:

getPath in interface ServiceRegistration

Returns:

The relative path to the service endpoint.

See Also:

• ServiceRegistration.getPath()

isJobProducer

public boolean isJobProducer()

Specified by:

isJobProducer in interface ServiceRegistration

Returns:

Whether the service performs long running operations using Jobs.

See Also:

• ServiceRegistration.isJobProducer()

isActive

public boolean isActive()

Specified by:

isActive in interface ServiceRegistration

Returns:

Whether the service is active

See Also:

• ServiceRegistration.isActive()

isOnline

public boolean isOnline()

Specified by:

isOnline in interface ServiceRegistration

Returns:

Whether the service is online

See Also:

• ServiceRegistration.isOnline()

isInMaintenanceMode

public boolean isInMaintenanceMode()

Whether the service is in maintenance mode. If a server was in maintenance mode when shut down, it will remain in maintenance mode when it comes back online

Specified by:

isInMaintenanceMode in interface ServiceRegistration

See Also:

• ServiceRegistration.isInMaintenanceMode()

setMaintenance

public void setMaintenance(boolean maintenance)

Sets the service's maintenance mode.

Parameters:

maintenance - true if the service is in maintenance mode

getService

public JobProducer getService()

Returns the actual service instance.

Returns:

the service

getOnlineFrom

public Date getOnlineFrom()

Gets the last time the service has been declared online

Specified by:

getOnlineFrom in interface ServiceRegistration

Returns:

the onlineFrom

See Also:

• ServiceRegistration.getOnlineFrom()

getServiceState

public ServiceState getServiceState()

Description copied from interface: ServiceRegistration

Gets the current state of the service

Specified by:

getServiceState in interface ServiceRegistration

Returns:

current state

getStateChanged

public Date getStateChanged()

Description copied from interface: ServiceRegistration

Gets the last date when state was changed

Specified by:

getStateChanged in interface ServiceRegistration

Returns:

last date when state was changed

getErrorStateTrigger

public int getErrorStateTrigger()

Description copied from interface: ServiceRegistration

Gets the job signature which changed last time the service state to error.

Specified by:

getErrorStateTrigger in interface ServiceRegistration

Returns:

the signature from error state trigger job

getWarningStateTrigger

public int getWarningStateTrigger()

Description copied from interface: ServiceRegistration

Gets the job signature which changed last time the service state to warning

Specified by:

getWarningStateTrigger in interface ServiceRegistration

Returns:

the signature from warning state trigger job

toString

public String toString()

Overrides:

toString in class Object