Package org.opencastproject.capture.admin.impl

Class CaptureAgentStateServiceImpl

java.lang.Object

org.opencastproject.capture.admin.impl.CaptureAgentStateServiceImpl

All Implemented Interfaces:

CaptureAgentStateService, org.osgi.service.cm.ManagedServiceFactory

public class CaptureAgentStateServiceImpl
extends Object
implements CaptureAgentStateService, org.osgi.service.cm.ManagedServiceFactory

IMPL for the capture-admin service (MH-1336, MH-1394, MH-1457, MH-1475 and MH-1476).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CAPTURE_AGENT_TIMEOUT_KEY	Configuration key for capture agent timeout in minutes before being marked offline
protected DBSession	db
protected DBSessionFactory	dbSessionFactory
protected javax.persistence.EntityManagerFactory	emf	The factory used to generate the entity manager
protected Object	nullToken	A token to store in the miss cache
static final String	PERSISTENCE_UNIT	The name of the persistence unit for this class
protected Map<String,String>	pidMap	Maps the configuration PID to the agent ID, so agents can be updated via the configuration factory pattern
protected SecurityService	securityService	The security service

Constructor Summary

Constructors

Constructor	Description
CaptureAgentStateServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)
void	deactivate()
void	deleted(String pid)
Agent	getAgent(String name)	Returns an agent by its name
protected AgentImpl	getAgent(String name, String org)	Gets an agent by name and organization.
Properties	getAgentCapabilities(String agentName)	Returns the list of known agent capabilities.
Properties	getAgentConfiguration(String agentName)	Returns the list of known agent configurations.
protected ThrowingFunction<javax.persistence.EntityManager,AgentImpl,NotFoundException>	getAgentEntityQuery(String name, String organization)	Gets an agent by name and organization, using an open entitymanager.
String	getAgentState(String agentName)	Returns the last known agent state by its name
Map<String,Agent>	getKnownAgents()	Returns the list of known agents that the current user is authorized to schedule.
String	getName()
void	removeAgent(String agentName)	Remove an agent from the system, if the agent exists.
boolean	setAgentConfiguration(String agentName, Properties configuration)	Sets the capabilities for the specified agent
boolean	setAgentState(String agentName, String state)	Sets a given agent's state.
boolean	setAgentUrl(String agentName, String agentUrl)
void	setDBSessionFactory(DBSessionFactory dbSessionFactory)
void	setSecurityService(SecurityService securityService)
protected void	setupAgentCache(int count, TimeUnit unit)
protected void	updateAgentInDatabase(AgentImpl agent)	Updates or adds an agent to the database.
protected Agent	updateCachedLastHeardFrom(Agent agent, String org)	Mix in the last-seen timestamp from the agent cache
void	updated(String pid, Dictionary<String,?> properties)

Methods inherited from class java.lang.Object

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

Field Details

PERSISTENCE_UNIT

public static final String PERSISTENCE_UNIT

The name of the persistence unit for this class

See Also:

• Constant Field Values

emf

protected javax.persistence.EntityManagerFactory emf

The factory used to generate the entity manager

dbSessionFactory

protected DBSessionFactory dbSessionFactory

db

protected DBSession db

securityService

protected SecurityService securityService

The security service

pidMap

protected Map<String,String> pidMap

Maps the configuration PID to the agent ID, so agents can be updated via the configuration factory pattern

CAPTURE_AGENT_TIMEOUT_KEY

public static final String CAPTURE_AGENT_TIMEOUT_KEY

Configuration key for capture agent timeout in minutes before being marked offline

See Also:

• Constant Field Values

nullToken

protected Object nullToken

A token to store in the miss cache

Constructor Details

CaptureAgentStateServiceImpl

public CaptureAgentStateServiceImpl()

Method Details

setDBSessionFactory

public void setDBSessionFactory(DBSessionFactory dbSessionFactory)

setSecurityService

public void setSecurityService(SecurityService securityService)

Parameters:

securityService - the securityService to set

activate

public void activate(org.osgi.service.component.ComponentContext cc)

deactivate

public void deactivate()

getAgent

public Agent getAgent(String name)
               throws NotFoundException

Returns an agent by its name

Specified by:

getAgent in interface CaptureAgentStateService

Parameters:

name - The name of the agent.

Returns:

The agent

Throws:

NotFoundException - if no agent with the given name has been found

See Also:

• CaptureAgentStateService.getAgent(java.lang.String)

getAgent

protected AgentImpl getAgent(String name,
 String org)
                      throws NotFoundException

Gets an agent by name and organization.

Parameters:

name - the unique agent name

org - the organization identifier

Returns:

the agent

Throws:

NotFoundException

getAgentEntityQuery

protected ThrowingFunction<javax.persistence.EntityManager,AgentImpl,NotFoundException> getAgentEntityQuery(String name,
 String organization)

Gets an agent by name and organization, using an open entitymanager.

Parameters:

name - the unique agent name

organization - the organization

Returns:

the agent or null if no agent has been found

updateCachedLastHeardFrom

protected Agent updateCachedLastHeardFrom(Agent agent,
 String org)

Mix in the last-seen timestamp from the agent cache

Parameters:

agent - The Agent you wish to update

org - the organization

Returns:

the agent

getAgentState

public String getAgentState(String agentName)
                     throws NotFoundException

Returns the last known agent state by its name

Specified by:

getAgentState in interface CaptureAgentStateService

Parameters:

agentName - The name of the agent.

Returns:

The agent state

Throws:

NotFoundException - if no agent with the given name has been found

See Also:

• CaptureAgentStateService.getAgentState(java.lang.String)

setAgentState

public boolean setAgentState(String agentName,
 String state)

Sets a given agent's state. Note that this will create the agent if it does not already exist. The state should be defined in AgentState.

Specified by:

setAgentState in interface CaptureAgentStateService

Parameters:

agentName - The name of the agent.

state - The current state of the agent.

See Also:

• CaptureAgentStateService.setAgentState(java.lang.String, java.lang.String)

setAgentUrl

public boolean setAgentUrl(String agentName,
 String agentUrl)
                    throws NotFoundException

Specified by:

setAgentUrl in interface CaptureAgentStateService

Parameters:

agentName - The name of the agent.

agentUrl - The url of the agent.

Throws:

NotFoundException - if no agent with the given name has been found

See Also:

• CaptureAgentStateService.setAgentUrl(String, String)

removeAgent

public void removeAgent(String agentName)
                 throws NotFoundException

Remove an agent from the system, if the agent exists.

Specified by:

removeAgent in interface CaptureAgentStateService

Parameters:

agentName - The name of the agent.

Throws:

NotFoundException - if no agent with the given name has been found

See Also:

• CaptureAgentStateService.removeAgent(java.lang.String)

getKnownAgents

public Map<String,Agent> getKnownAgents()

Returns the list of known agents that the current user is authorized to schedule.

Specified by:

getKnownAgents in interface CaptureAgentStateService

Returns:

A Map of name-agent pairs.

See Also:

• CaptureAgentStateService.getKnownAgents()

getAgentCapabilities

public Properties getAgentCapabilities(String agentName)
                                throws NotFoundException

Returns the list of known agent capabilities.

Specified by:

getAgentCapabilities in interface CaptureAgentStateService

Returns:

A Properties of name-value capability pairs.

Throws:

NotFoundException - if no agent with the given name has been found

See Also:

• CaptureAgentStateService.getAgentCapabilities(java.lang.String)

getAgentConfiguration

public Properties getAgentConfiguration(String agentName)
                                 throws NotFoundException

Returns the list of known agent configurations.

Specified by:

getAgentConfiguration in interface CaptureAgentStateService

Returns:

A Properties of name-value configuration pairs.

Throws:

NotFoundException - if no agent with the given name has been found

See Also:

• CaptureAgentStateService.getAgentConfiguration(java.lang.String)

setAgentConfiguration

public boolean setAgentConfiguration(String agentName,
 Properties configuration)

Sets the capabilities for the specified agent

Specified by:

setAgentConfiguration in interface CaptureAgentStateService

Parameters:

agentName -

configuration -

Returns:

One of the constants defined in this class

See Also:

• CaptureAgentStateService.setAgentConfiguration(java.lang.String, java.util.Properties)

updateAgentInDatabase

protected void updateAgentInDatabase(AgentImpl agent)

Updates or adds an agent to the database.

Parameters:

agent - The Agent you wish to modify or add in the database.

getName

public String getName()

Specified by:

getName in interface org.osgi.service.cm.ManagedServiceFactory

See Also:

• ManagedServiceFactory.getName()

setupAgentCache

protected void setupAgentCache(int count,
 TimeUnit unit)

updated

public void updated(String pid,
 Dictionary<String,?> properties)
             throws org.osgi.service.cm.ConfigurationException

Specified by:

updated in interface org.osgi.service.cm.ManagedServiceFactory

Throws:

org.osgi.service.cm.ConfigurationException

See Also:

• ManagedServiceFactory.updated(java.lang.String, java.util.Dictionary)

deleted

public void deleted(String pid)

Specified by:

deleted in interface org.osgi.service.cm.ManagedServiceFactory

See Also:

• ManagedServiceFactory.deleted(java.lang.String)