Package org.opencastproject.serviceregistry.api

Class JaxbServiceRegistration

java.lang.Object

org.opencastproject.serviceregistry.api.JaxbServiceRegistration

All Implemented Interfaces:

ServiceRegistration

public class JaxbServiceRegistration
extends Object
implements ServiceRegistration

A record of a service that creates and manages receipts.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	active
protected int	errorStateTrigger
protected String	host
protected boolean	jobProducer
protected boolean	maintenanceMode
protected boolean	online
protected Date	onlineFrom	The last time the service has been declared online
protected String	path
protected ServiceState	serviceState
protected String	serviceType
protected Date	stateChanged
protected int	warningStateTrigger

Constructor Summary

Constructors

Constructor	Description
JaxbServiceRegistration()	Creates a new service registration which is online and not in maintenance mode.
JaxbServiceRegistration(String serviceType, String host, String path)	Creates a new service registration which is online and not in maintenance mode.
JaxbServiceRegistration(String serviceType, String host, String path, boolean jobProducer)	Creates a new service registration which is online and not in maintenance mode.
JaxbServiceRegistration(ServiceRegistration serviceRegistration)	Creates a new JAXB annotated service registration based on an existing service registration

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
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()
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
int	hashCode()
boolean	isActive()
boolean	isInMaintenanceMode()	Whether the service is in maintenance mode.
boolean	isJobProducer()
boolean	isOnline()
void	setActive(boolean active)
void	setErrorStateTrigger(int jobSignature)	Sets the job which triggered the last error state
void	setHost(String host)
void	setInMaintenanceMode(boolean maintenanceMode)	Sets the maintenance status of this service registration
void	setJobProducer(boolean jobProducer)	Sets whether this service registration is a job producer.
void	setOnline(boolean online)	Sets the online status of this service registration
void	setOnlineFrom(Date onlineFrom)	Sets the last time the service has been declared online
void	setPath(String path)
void	setServiceState(ServiceState state)	Sets the current state of the service.
void	setServiceState(ServiceState state, int triggerJobSignature)	Sets the current state of the service and the trigger Job.
void	setServiceType(String serviceType)
void	setStateChanged(Date stateChanged)	Sets the last date when the state was changed
void	setWarningStateTrigger(int jobSignature)	Sets the job which triggered the last warning state
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

serviceType

protected String serviceType

host

protected String host

path

protected String path

active

protected boolean active

online

protected boolean online

maintenanceMode

protected boolean maintenanceMode

jobProducer

protected boolean jobProducer

onlineFrom

protected Date onlineFrom

The last time the service has been declared online

serviceState

protected ServiceState serviceState

stateChanged

protected Date stateChanged

errorStateTrigger

protected int errorStateTrigger

warningStateTrigger

protected int warningStateTrigger

Constructor Details

JaxbServiceRegistration

public JaxbServiceRegistration()

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

JaxbServiceRegistration

public JaxbServiceRegistration(ServiceRegistration serviceRegistration)

Creates a new JAXB annotated service registration based on an existing service registration

Parameters:

serviceRegistration -

JaxbServiceRegistration

public JaxbServiceRegistration(String serviceType,
 String host,
 String path)

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

Parameters:

serviceType - the job type

host - the host

JaxbServiceRegistration

public JaxbServiceRegistration(String serviceType,
 String host,
 String path,
 boolean jobProducer)

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

Parameters:

serviceType - the job type

host - the host

jobProducer -

Method Details

getHost

public String getHost()

Specified by:

getHost in interface ServiceRegistration

Returns:

the host providing the service endpoint.

See Also:

• ServiceRegistration.getHost()

setHost

public void setHost(String host)

Parameters:

host - the host to set

getServiceType

public String getServiceType()

Specified by:

getServiceType in interface ServiceRegistration

Returns:

the type of service

See Also:

• ServiceRegistration.getServiceType()

setServiceType

public void setServiceType(String serviceType)

Parameters:

serviceType - the serviceType to set

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()

setInMaintenanceMode

public void setInMaintenanceMode(boolean maintenanceMode)

Sets the maintenance status of this service registration

Parameters:

maintenanceMode -

isActive

public boolean isActive()

Specified by:

isActive in interface ServiceRegistration

Returns:

Whether the service is active

See Also:

• ServiceRegistration.isActive()

setActive

public void setActive(boolean active)

isOnline

public boolean isOnline()

Specified by:

isOnline in interface ServiceRegistration

Returns:

Whether the service is online

See Also:

• ServiceRegistration.isOnline()

setOnline

public void setOnline(boolean online)

Sets the online status of this service registration

Parameters:

online -

getPath

public String getPath()

Specified by:

getPath in interface ServiceRegistration

Returns:

The relative path to the service endpoint.

See Also:

• ServiceRegistration.getPath()

setPath

public void setPath(String path)

Parameters:

path - the path to set

isJobProducer

public boolean isJobProducer()

Specified by:

isJobProducer in interface ServiceRegistration

Returns:

Whether the service performs long running operations using Jobs.

See Also:

• ServiceRegistration.isJobProducer()

setJobProducer

public void setJobProducer(boolean jobProducer)

Sets whether this service registration is a job producer.

Parameters:

jobProducer - the jobProducer to set

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()

setOnlineFrom

public void setOnlineFrom(Date onlineFrom)

Sets the last time the service has been declared online

Parameters:

onlineFrom - the onlineFrom to set

getServiceState

public ServiceState getServiceState()

Gets the current state of the service

Specified by:

getServiceState in interface ServiceRegistration

Returns:

current state

See Also:

• ServiceRegistration.getServiceState()

setServiceState

public void setServiceState(ServiceState state)

Sets the current state of the service.

Parameters:

state - current state

setServiceState

public void setServiceState(ServiceState state,
 int triggerJobSignature)

Sets the current state of the service and the trigger Job. If the state is set to ServiceState.WARNING or ServiceState.ERROR the triggered job will be set.

Parameters:

state - the service state

triggerJobSignature - the triggered job signature

getStateChanged

public Date getStateChanged()

Gets the last date when state was changed

Specified by:

getStateChanged in interface ServiceRegistration

Returns:

last date when state was changed

See Also:

• ServiceRegistration.getStateChanged()

setStateChanged

public void setStateChanged(Date stateChanged)

Sets the last date when the state was changed

Parameters:

stateChanged - last date

getErrorStateTrigger

public int getErrorStateTrigger()

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

See Also:

• ServiceRegistration.getErrorStateTrigger()

setErrorStateTrigger

public void setErrorStateTrigger(int jobSignature)

Sets the job which triggered the last error state

Parameters:

jobSignature - the job

getWarningStateTrigger

public int getWarningStateTrigger()

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

See Also:

• ServiceRegistration.getWarningStateTrigger()

setWarningStateTrigger

public void setWarningStateTrigger(int jobSignature)

Sets the job which triggered the last warning state

Parameters:

jobSignature - the job

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()