com.centurylink.mdw.service.rest

Class Ping

java.lang.Object

com.centurylink.mdw.services.rest.RestService

com.centurylink.mdw.services.rest.JsonRestService

com.centurylink.mdw.service.rest.Ping

All Implemented Interfaces:

JsonService, RegisteredService, TextService

public class Ping
extends JsonRestService

Field Summary

Fields inherited from class com.centurylink.mdw.services.rest.RestService

HTTP_200_OK, HTTP_201_CREATED, HTTP_202_ACCEPTED, HTTP_400_BAD_REQUEST, HTTP_401_UNAUTHORIZED, HTTP_403_FORBIDDEN, HTTP_404_NOT_FOUND, HTTP_405_METHOD_NOT_ALLOWED, HTTP_409_CONFLICT, HTTP_500_INTERNAL_ERROR, HTTP_501_NOT_IMPLEMENTED

Constructor Summary

Constructors

Constructor and Description
Ping()

Method Summary

Modifier and Type	Method and Description
protected UserAction.Action	getAction(java.lang.String path, java.lang.Object content, java.util.Map<java.lang.String,java.lang.String> headers)
protected UserAction.Entity	getEntity(java.lang.String path, java.lang.Object content, java.util.Map<java.lang.String,java.lang.String> headers) Should be overridden.
java.util.List<java.lang.String>	getRoles(java.lang.String path) A user who belongs to any role in the returned list is allowed to perform this action/method.
org.json.JSONObject	post(java.lang.String path, org.json.JSONObject content, java.util.Map<java.lang.String,java.lang.String> headers) Create a new entity or relationship.

Methods inherited from class com.centurylink.mdw.services.rest.JsonRestService

delete, export, get, getDefaultResponse, getExporter, getJson, getText, invokeServiceProcess, isApi, launchProcess, notifyProcess, notifyProcess, patch, put, service, validateResponse

Methods inherited from class com.centurylink.mdw.services.rest.RestService

auditLog, authorize, authorizeExport, generateRequestId, getAuthUser, getEntityDescription, getEntityId, getParameters, getQuery, getRequestUrl, getRequiredProperty, getRoles, getSegment, getSegments, getSource, getSub, getUserAction, logtag, masterRequestId

Methods inherited from class java.lang.Object

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

Constructor Detail

Ping

public Ping()

Method Detail

getRoles

public java.util.List<java.lang.String> getRoles(java.lang.String path)

Description copied from class: RestService

A user who belongs to any role in the returned list is allowed to perform this action/method. Override to open access beyond Site Admin.

Overrides:

getRoles in class RestService

Returns:

list of role names or null if authorization not required

getEntity

protected UserAction.Entity getEntity(java.lang.String path,
                                      java.lang.Object content,
                                      java.util.Map<java.lang.String,java.lang.String> headers)

Description copied from class: RestService

Should be overridden. Avoid using Entity.Other.

Overrides:

getEntity in class RestService

getAction

protected UserAction.Action getAction(java.lang.String path,
                                      java.lang.Object content,
                                      java.util.Map<java.lang.String,java.lang.String> headers)

Overrides:

getAction in class RestService

post

public org.json.JSONObject post(java.lang.String path,
                                org.json.JSONObject content,
                                java.util.Map<java.lang.String,java.lang.String> headers)
                         throws ServiceException,
                                org.json.JSONException

Description copied from class: JsonRestService

Create a new entity or relationship. Or perform other action requests that cannot be categorized into put or delete.

Overrides:

post in class JsonRestService

Throws:

ServiceException

org.json.JSONException