org.openecomp.aai.rest

Class RESTAPI

java.lang.Object

org.openecomp.aai.rest.RESTAPI

Direct Known Subclasses:

ActionsProvider, BulkAddConsumer, EchoResponse, ExampleConsumer, LegacyMoxyConsumer, ModelAndNamedQueryRestProvider, RestProviders, SearchProvider, TransLogRestProvider, URLFromVertexIdConsumer, VertexIdConsumer

public class RESTAPI
extends Object

Base class for AAI REST API classes. Provides method to validate header information TODO should authenticate caller and authorize them for the API they are calling TODO should store the transaction

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RESTAPI.Action The Enum Action.

Field Summary

Fields

Modifier and Type	Field and Description
protected static AAILogger	aaiLogger
protected String	COMPONENT
AAITxnLog	txn

Constructor Summary

Constructors

Constructor and Description
RESTAPI()

Method Summary

Modifier and Type	Method and Description
protected javax.ws.rs.core.Response	consumerExceptionResponseGenerator(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo info, HttpMethod templateAction, AAIException e, LogLine logline) Consumer exception response generator.
protected String	genDate() Gen date.
protected String	genDate(LogLine logline) Gen date.
protected org.eclipse.persistence.dynamic.DynamicEntity	getDynamicEntityForRequest(org.eclipse.persistence.jaxb.dynamic.DynamicJAXBContext jaxbContext, AAIResource aaiRes, String objectFromRequest, AAIExtensionMap aaiExtMap) Gets the dynamic entity for request.
protected String	getFromAppId(javax.ws.rs.core.HttpHeaders headers, LogLine logline) Gets the from app id.
protected String	getMediaType(List<javax.ws.rs.core.MediaType> mediaTypeList) Gets the media type.
protected String	getTransId(javax.ws.rs.core.HttpHeaders headers, LogLine logline) Gets the trans id.
void	logTransaction(String appId, String tId, String action, String input, String rqstTm, String respTm, String request, javax.ws.rs.core.Response response, LogLine logline) Log transaction.
void	logTransaction(String appId, String tId, String action, String input, String rqstTm, String respTm, String request, String respBuf, String status) Log transaction.
void	logTransaction(String appId, String tId, String action, String input, String rqstTm, String respTm, String request, String respBuf, String status, LogLine logline) Log transaction.
protected int	setDepth(String depthParam) Sets the depth.
protected void	validateIntrospector(Introspector obj, Loader loader, URI uri, boolean validateRequired) Validate introspector.

Methods inherited from class java.lang.Object

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

Field Detail

aaiLogger

protected static AAILogger aaiLogger

COMPONENT

protected final String COMPONENT

See Also:

Constant Field Values

txn

public AAITxnLog txn

Constructor Detail

RESTAPI

public RESTAPI()

Method Detail

getFromAppId

protected String getFromAppId(javax.ws.rs.core.HttpHeaders headers,
                              LogLine logline)
                       throws AAIException

Gets the from app id.

Parameters:

headers - the headers

logline - the logline

Returns:

the from app id

Throws:

AAIException - the AAI exception

getTransId

protected String getTransId(javax.ws.rs.core.HttpHeaders headers,
                            LogLine logline)
                     throws AAIException

Gets the trans id.

Parameters:

headers - the headers

logline - the logline

Returns:

the trans id

Throws:

AAIException - the AAI exception

genDate

protected String genDate()

Gen date.

Returns:

the string

genDate

protected String genDate(LogLine logline)

Gen date.

Parameters:

logline - the logline

Returns:

the string

getMediaType

protected String getMediaType(List<javax.ws.rs.core.MediaType> mediaTypeList)

Gets the media type.

Parameters:

mediaTypeList - the media type list

Returns:

the media type

getDynamicEntityForRequest

protected org.eclipse.persistence.dynamic.DynamicEntity getDynamicEntityForRequest(org.eclipse.persistence.jaxb.dynamic.DynamicJAXBContext jaxbContext,
                                                                                   AAIResource aaiRes,
                                                                                   String objectFromRequest,
                                                                                   AAIExtensionMap aaiExtMap)
                                                                            throws JAXBException

Gets the dynamic entity for request.

Parameters:

jaxbContext - the jaxb context

aaiRes - the aai res

objectFromRequest - the object from request

aaiExtMap - the aai ext map

Returns:

the dynamic entity for request

Throws:

JAXBException - the JAXB exception

logTransaction

public void logTransaction(String appId,
                           String tId,
                           String action,
                           String input,
                           String rqstTm,
                           String respTm,
                           String request,
                           String respBuf,
                           String status)

Log transaction.

Parameters:

appId - the app id

tId - the t id

action - the action

input - the input

rqstTm - the rqst tm

respTm - the resp tm

request - the request

respBuf - the resp buf

status - the status

logTransaction

public void logTransaction(String appId,
                           String tId,
                           String action,
                           String input,
                           String rqstTm,
                           String respTm,
                           String request,
                           javax.ws.rs.core.Response response,
                           LogLine logline)

Log transaction.

Parameters:

appId - the app id

tId - the t id

action - the action

input - the input

rqstTm - the rqst tm

respTm - the resp tm

request - the request

response - the response

logline - the logline

logTransaction

public void logTransaction(String appId,
                           String tId,
                           String action,
                           String input,
                           String rqstTm,
                           String respTm,
                           String request,
                           String respBuf,
                           String status,
                           LogLine logline)

Log transaction.

Parameters:

appId - the app id

tId - the t id

action - the action

input - the input

rqstTm - the rqst tm

respTm - the resp tm

request - the request

respBuf - the resp buf

status - the status

logline - the logline

setDepth

protected int setDepth(String depthParam)
                throws AAIException

Sets the depth.

Parameters:

depthParam - the depth param

Returns:

the int

Throws:

AAIException - the AAI exception

consumerExceptionResponseGenerator

protected javax.ws.rs.core.Response consumerExceptionResponseGenerator(javax.ws.rs.core.HttpHeaders headers,
                                                                       javax.ws.rs.core.UriInfo info,
                                                                       HttpMethod templateAction,
                                                                       AAIException e,
                                                                       LogLine logline)

Consumer exception response generator.

Parameters:

headers - the headers

info - the info

templateAction - the template action

e - the e

logline - the logline

Returns:

the response

validateIntrospector

protected void validateIntrospector(Introspector obj,
                                    Loader loader,
                                    URI uri,
                                    boolean validateRequired)
                             throws AAIException,
                                    UnsupportedEncodingException

Validate introspector.

Parameters:

obj - the obj

loader - the loader

uri - the uri

validateRequired - the validate required

Throws:

AAIException - the AAI exception

UnsupportedEncodingException - the unsupported encoding exception