com.centurylink.mdw.staging

Class StagingApi

java.lang.Object

com.centurylink.mdw.services.rest.RestService

com.centurylink.mdw.services.rest.JsonRestService

com.centurylink.mdw.staging.StagingApi

All Implemented Interfaces:

JsonService, RegisteredService, TextService

public class StagingApi
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
StagingApi()

Method Summary

Modifier and Type	Method and Description
protected User	authorize(java.lang.String path, org.json.JSONObject content, java.util.Map<java.lang.String,java.lang.String> headers) The user identified in the AuthenticatedUser headers must be authorized to perform this action.
org.json.JSONObject	delete(java.lang.String path, org.json.JSONObject content, java.util.Map<java.lang.String,java.lang.String> headers) Delete means unstage.
org.json.JSONObject	get(java.lang.String path, java.util.Map<java.lang.String,java.lang.String> headers) Paths in case this API becomes public / = get all user staging areas /<cuid> = get staging area for user /<cuid>/assets = staged assets for user
org.json.JSONObject	patch(java.lang.String path, org.json.JSONObject content, java.util.Map<java.lang.String,java.lang.String> headers) Patch requests mean 'Promote' (or merge with main branch).
org.json.JSONObject	post(java.lang.String path, org.json.JSONObject content, java.util.Map<java.lang.String,java.lang.String> headers) Prepare staging area, or add assets to staging area.
org.json.JSONObject	put(java.lang.String path, org.json.JSONObject content, java.util.Map<java.lang.String,java.lang.String> headers) Put requests mean stage 'Rollback' to previous asset versions.

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

export, getDefaultResponse, getExporter, getJson, getText, invokeServiceProcess, isApi, launchProcess, notifyProcess, notifyProcess, service, validateResponse

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

auditLog, authorizeExport, generateRequestId, getAction, getAuthUser, getEntity, getEntityDescription, getEntityId, getParameters, getQuery, getRequestUrl, getRequiredProperty, getRoles, 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

StagingApi

public StagingApi()

Method Detail

authorize

protected User authorize(java.lang.String path,
                         org.json.JSONObject content,
                         java.util.Map<java.lang.String,java.lang.String> headers)
                  throws AuthorizationException

Description copied from class: RestService

The user identified in the AuthenticatedUser headers must be authorized to perform this action. For HTTP, MDW removes this header (if it exists) from every request and then populates based on session authentication or HTTP Basic.

Overrides:

authorize in class RestService

Returns:

authorized user if successful

Throws:

AuthorizationException

get

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

Paths in case this API becomes public / = get all user staging areas /<cuid> = get staging area for user /<cuid>/assets = staged assets for user

Overrides:

get in class JsonRestService

Throws:

ServiceException

org.json.JSONException

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

Prepare staging area, or add assets to staging area.

Overrides:

post in class JsonRestService

Throws:

ServiceException

org.json.JSONException

patch

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

Patch requests mean 'Promote' (or merge with main branch).

Overrides:

patch in class JsonRestService

Throws:

ServiceException

org.json.JSONException

put

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

Put requests mean stage 'Rollback' to previous asset versions.

Overrides:

put in class JsonRestService

Throws:

ServiceException

org.json.JSONException

delete

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

Delete means unstage.

Overrides:

delete in class JsonRestService

Throws:

ServiceException

org.json.JSONException