Package org.opencastproject.runtimeinfo

Class RuntimeInfo

java.lang.Object

org.opencastproject.runtimeinfo.RuntimeInfo

@Path("/info")
public class RuntimeInfo
extends Object

This REST endpoint provides information about the runtime environment, including the services and user interfaces deployed and the current login context. If the 'org.opencastproject.anonymous.feedback.url' is set in config.properties, this service will also update the opencast project with the contents of the getRuntimeInfo() json feed.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HEALTH_CHECK_STATUS_FAIL
static final String	HEALTH_CHECK_STATUS_PASS
static final String	HEALTH_CHECK_STATUS_WARN
static final String	HEALTH_CHECK_VERSION
static final String	SERVICE_FILTER	The rest publisher looks for any non-servlet with the 'opencast.service.path' property

Constructor Summary

Constructors

Constructor	Description
RuntimeInfo()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)
String	getHealth(javax.servlet.http.HttpServletResponse response)
String	getMyInfo()
String	getRuntimeInfo(javax.servlet.http.HttpServletRequest request)
protected Map<String,Object>	getServiceStateAsJson(org.opencastproject.serviceregistry.api.ServiceRegistration service)
protected void	setSecurityService(org.opencastproject.security.api.SecurityService securityService)
protected void	setServiceRegistry(org.opencastproject.serviceregistry.api.ServiceRegistry serviceRegistry)
protected void	setUserIdRoleProvider(org.opencastproject.userdirectory.UserIdRoleProvider userIdRoleProvider)
protected void	unsetUserIdRoleProvider(org.opencastproject.userdirectory.UserIdRoleProvider userIdRoleProvider)

Methods inherited from class java.lang.Object

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

Field Details

HEALTH_CHECK_VERSION

public static final String HEALTH_CHECK_VERSION

See Also:

• Constant Field Values

HEALTH_CHECK_STATUS_PASS

public static final String HEALTH_CHECK_STATUS_PASS

See Also:

• Constant Field Values

HEALTH_CHECK_STATUS_WARN

public static final String HEALTH_CHECK_STATUS_WARN

See Also:

• Constant Field Values

HEALTH_CHECK_STATUS_FAIL

public static final String HEALTH_CHECK_STATUS_FAIL

See Also:

• Constant Field Values

SERVICE_FILTER

public static final String SERVICE_FILTER

The rest publisher looks for any non-servlet with the 'opencast.service.path' property

See Also:

• Constant Field Values

Constructor Details

RuntimeInfo

public RuntimeInfo()

Method Details

setUserIdRoleProvider

protected void setUserIdRoleProvider(org.opencastproject.userdirectory.UserIdRoleProvider userIdRoleProvider)

unsetUserIdRoleProvider

protected void unsetUserIdRoleProvider(org.opencastproject.userdirectory.UserIdRoleProvider userIdRoleProvider)

setSecurityService

protected void setSecurityService(org.opencastproject.security.api.SecurityService securityService)

setServiceRegistry

protected void setServiceRegistry(org.opencastproject.serviceregistry.api.ServiceRegistry serviceRegistry)

activate

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

Throws:

MalformedURLException

getRuntimeInfo

@GET
@Produces("application/json")
@Path("components.json")
public String getRuntimeInfo(@Context
 javax.servlet.http.HttpServletRequest request)
                      throws MalformedURLException,
org.osgi.framework.InvalidSyntaxException

Throws:

MalformedURLException

org.osgi.framework.InvalidSyntaxException

getMyInfo

@GET
@Path("me.json")
@Produces("application/json")
public String getMyInfo()

getHealth

@GET
@Path("health")
@Produces("application/health+json")
public String getHealth(@Context
 javax.servlet.http.HttpServletResponse response)

getServiceStateAsJson

protected Map<String,Object> getServiceStateAsJson(org.opencastproject.serviceregistry.api.ServiceRegistration service)