org.alfresco.rest.api.probes

Class ProbeEntityResource

java.lang.Object

org.alfresco.rest.api.probes.ProbeEntityResource

All Implemented Interfaces:

EntityResourceAction.ReadById<Probe>, ResourceAction

@EntityResource(name="probes",
                title="Probes")
public class ProbeEntityResource
extends Object
implements EntityResourceAction.ReadById<Probe>

An implementation of an Entity Resource for Probes.

Field Summary

Fields

Modifier and Type	Field and Description
static long	CHECK_PERIOD
static String	LIVE
protected static org.apache.commons.logging.Log	logger
static String	READY

Constructor Summary

Constructors

Constructor and Description
ProbeEntityResource()

Method Summary

Modifier and Type	Method and Description
String	doCheckOrNothing(boolean isLiveProbe)
Probe	readById(String name, Parameters parameters) Returns a status code of 200 for okay.
DiscoveryApiWebscript	setDiscovery(DiscoveryApiWebscript discovery)

Methods inherited from class java.lang.Object

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

Field Detail

LIVE

public static final String LIVE

See Also:

Constant Field Values

READY

public static final String READY

See Also:

Constant Field Values

CHECK_PERIOD

public static final long CHECK_PERIOD

See Also:

Constant Field Values

logger

protected static org.apache.commons.logging.Log logger

Constructor Detail

ProbeEntityResource

public ProbeEntityResource()

Method Detail

setDiscovery

public DiscoveryApiWebscript setDiscovery(DiscoveryApiWebscript discovery)

readById

@WebApiNoAuth
public Probe readById(String name,
                                    Parameters parameters)

Returns a status code of 200 for okay. The probe contains little information for security reasons. Note: does *not* require authenticated access, so limits the amount of work performed to avoid a DDOS.

Specified by:

readById in interface EntityResourceAction.ReadById<Probe>

doCheckOrNothing

public String doCheckOrNothing(boolean isLiveProbe)