org.apache.brooklyn.rest.api

Interface ServerApi

All Known Implementing Classes:

ServerResource

@Path(value="/server")
 @Produces(value="application/json")
public interface ServerApi

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MIME_TYPE_TGZ
static java.lang.String	MIME_TYPE_ZIP

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	clearHighAvailabilityPlaneStates()
javax.ws.rs.core.Response	exportPersistenceData(java.lang.String origin)
java.lang.String	getConfig(java.lang.String configKey)
java.util.Map<java.lang.String,java.lang.Object>	getHighAvailabilityMetrics()
ManagementNodeState	getHighAvailabilityNodeState()
HighAvailabilitySummary	getHighAvailabilityPlaneStates()
long	getHighAvailabitlityPriority()
java.lang.String	getPlaneId()
java.util.Map<java.lang.String,java.lang.Object>	getUpExtended()
java.lang.String	getUser()
VersionSummary	getVersion()
boolean	isHealthy()
boolean	isShuttingDown()
boolean	isUp()
void	reloadBrooklynProperties()
ManagementNodeState	setHighAvailabilityNodeState(HighAvailabilityMode mode)
long	setHighAvailabilityPriority(long priority)
void	shutdown(boolean stopAppsFirst, boolean forceShutdownOnError, java.lang.String shutdownTimeout, java.lang.String requestTimeout, java.lang.String delayForHttpReturn, java.lang.Long delayMillis)

Field Detail

MIME_TYPE_ZIP

static final java.lang.String MIME_TYPE_ZIP

See Also:

Constant Field Values

MIME_TYPE_TGZ

static final java.lang.String MIME_TYPE_TGZ

See Also:

Constant Field Values

Method Detail

reloadBrooklynProperties

@POST
 @Path(value="/properties/reload")
void reloadBrooklynProperties()

shutdown

@POST
 @Path(value="/shutdown")
 @Consumes(value="application/x-www-form-urlencoded")
void shutdown(@FormParam(value="stopAppsFirst") @DefaultValue(value="false")
                                                                                                    boolean stopAppsFirst,
                                                                                                    @FormParam(value="forceShutdownOnError") @DefaultValue(value="false")
                                                                                                    boolean forceShutdownOnError,
                                                                                                    @FormParam(value="shutdownTimeout") @DefaultValue(value="20s")
                                                                                                    java.lang.String shutdownTimeout,
                                                                                                    @FormParam(value="requestTimeout") @DefaultValue(value="20s")
                                                                                                    java.lang.String requestTimeout,
                                                                                                    @FormParam(value="delayForHttpReturn") @DefaultValue(value="5s")
                                                                                                    java.lang.String delayForHttpReturn,
                                                                                                    @FormParam(value="delayMillis")
                                                                                                    java.lang.Long delayMillis)

getVersion

@GET
 @Path(value="/version")
VersionSummary getVersion()

getPlaneId

@GET
 @Path(value="/planeid")
java.lang.String getPlaneId()

isUp

@GET
 @Path(value="/up")
boolean isUp()

isShuttingDown

@GET
 @Path(value="/shuttingDown")
boolean isShuttingDown()

isHealthy

@GET
 @Path(value="/healthy")
boolean isHealthy()

getUpExtended

@GET
 @Path(value="/up/extended")
java.util.Map<java.lang.String,java.lang.Object> getUpExtended()

getConfig

@GET
 @Path(value="/config/{configKey}")
java.lang.String getConfig(@PathParam(value="configKey")
                                                                    java.lang.String configKey)

getHighAvailabilityNodeState

@GET
 @Path(value="/ha/state")
ManagementNodeState getHighAvailabilityNodeState()

getHighAvailabilityMetrics

@GET
 @Path(value="/ha/metrics")
java.util.Map<java.lang.String,java.lang.Object> getHighAvailabilityMetrics()

setHighAvailabilityNodeState

@POST
 @Path(value="/ha/state")
ManagementNodeState setHighAvailabilityNodeState(@FormParam(value="mode")
                                                                                 HighAvailabilityMode mode)

getHighAvailabilityPlaneStates

@GET
 @Path(value="/ha/states")
HighAvailabilitySummary getHighAvailabilityPlaneStates()

clearHighAvailabilityPlaneStates

@POST
 @Path(value="/ha/states/clear")
javax.ws.rs.core.Response clearHighAvailabilityPlaneStates()

getHighAvailabitlityPriority

@GET
 @Path(value="/ha/priority")
long getHighAvailabitlityPriority()

setHighAvailabilityPriority

@POST
 @Path(value="/ha/priority")
long setHighAvailabilityPriority(@FormParam(value="priority")
                                                                    long priority)

exportPersistenceData

@GET
 @Produces(value="application/zip")
 @Path(value="/ha/persist/export")
javax.ws.rs.core.Response exportPersistenceData(@QueryParam(value="origin") @DefaultValue(value="AUTO")
                                                                                                                            java.lang.String origin)

getUser

@GET
 @Path(value="/user")
java.lang.String getUser()