com.ibm.tivoli.maximo.oslc.provider

Class AbstractRouteHandler

java.lang.Object

com.ibm.tivoli.maximo.oslc.provider.AbstractRouteHandler

Direct Known Subclasses:

AdminModeRouteHandler, AHDeviceSheetLocationHandler, AHDeviceSheetPostRouteHandler, ApiKeyRouteHandler, APIMetaQueryListRouteHandler, APIMetaRouteHandler, APIValidationRouteHandler, AppConfigRouteHandler, AsyncFileImportStatusRouteHandler, AsyncFileRouteHandler, BrowseMessageHubRouteHandler, CacheRefreshRouteHandler, ChangePasswordRouteHandler, ConvertRouteHandler, COSDoclinkRouteHandler, COSRouteHandler, DateTimeRouteHandler, DebugSessionRouteHandler, DemoDataRouteHandler, DMRouteHandler, DoclinkZipRouteHandler, EndpointRouteHandler, ErrorRouteHandler, ExtresRouteHandler, ForgotPasswordRouteHandler, GLLookupRouteHandler, GraphQLRouteHandler, GraphQLSchemaRouteHandler, ImageRouteHandler, ImportCertRouteHandler, InsightsRouteHandler, JSONMboSchemaRouteHandler, JSONSchemaRouteHandler, LicenseInfoRouteHandler, LoginRouteHandler, LogoutRouteHandler, LogRouteHandler, MapConfigurationHandler, MASDDRouteHandler, MaxMessagesRouteHandler, MMIHttpRouteHandler, MMIRouteHandler, MsgHubRouteHandler, MyNotificationsRouteHandler, MyPersonRouteHandler, MyUserRouteHandler, NLQueryRouteHandler, NPSRouteHandler, OASRouteHandler, OSGETRouteHandler, OSPOSTRouteHandler, PasswordRulesRouteHandler, PermissionRouteHandler, PingRouteHandler, PushNotificationsProviderHandler, QueryMetaRouteHandler, RefreshTokenRouteHandler, ScriptRouteHandler, ServiceRouteHandler, ShapesRouteHandler, SPRouteHandler, StreamMboDataHandler, TenantUsageRouteHandler, TestRouteHandler, TourTrackRouteHandler, UITextRouteHandler, WCglobalCfgRouteHandler, WFInputRouteHandler, WhoamiRouteHandler, YamlRouteHandler

public abstract class AbstractRouteHandler
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected MXCorrelator	correlator
protected java.lang.String	httpMethod
protected MXLogger	logger
protected MaximoAuthenticator	maxAuthHandler
protected java.lang.String	provider
protected byte[]	requestData
protected java.lang.String	resourceReq
protected java.util.List	resPath
protected RouteInfo	routeInfo

Constructor Summary

Constructors

Constructor and Description
AbstractRouteHandler()

Method Summary

Modifier and Type	Method and Description
protected OslcResourceResponse	acceptedResponse(java.lang.String location)
protected void	addCorrelationData(java.lang.String label, java.lang.String dataItem)
MXSession	authenticateRequest(OslcRequest request)
protected java.util.Set	booleanEnumSet()
protected void	checkAuth(UserInfo userInfo, java.lang.String optionName, java.lang.String context)
protected void	correlateResponseDataSize(byte[] resourceRep)
protected OslcResourceResponse	errorJSONResponse(com.ibm.json.java.JSONObject jo, int status)
protected OslcResourceResponse	errorResponse(byte[] respData, int status, java.lang.String respContentType)
java.util.Set	getPathTokenAllowedValuesMeta(java.lang.String token)
java.util.Map	getPathTokensMeta()
java.lang.String	getProvider()
java.util.Set	getQueryParamAllowedValuesMeta(java.lang.String qparam)
java.util.List	getQueryParamsMeta(java.lang.String path)
protected byte[]	getRequestDataAsBytes()
protected com.ibm.json.java.JSONArtifact	getRequestDataAsJSON()
protected com.ibm.json.java.JSONArray	getRequestDataAsJSONArray()
protected com.ibm.json.java.JSONObject	getRequestDataAsJSONObject()
protected java.lang.String	getRequestDataAsText()
abstract OslcResourceResponse	handleRequest(OslcRequest request)
boolean	isMonitorRouteAllowed()
boolean	isPathTokensOptional()
protected void	logTransaction(OslcRequest request, java.lang.Long mboId, MXTransaction mxTran)
protected OslcResourceResponse	okJSONResponse(byte[] data)
protected OslcResourceResponse	okJSONResponse(com.ibm.json.java.JSONArray ja)
protected OslcResourceResponse	okJSONResponse(com.ibm.json.java.JSONArtifact ja)
protected OslcResourceResponse	okJSONResponse(com.ibm.json.java.JSONObject ja)
protected OslcResourceResponse	okJSONResponse(OslcResourceResponse data)
protected OslcResourceResponse	okResponse()
protected OslcResourceResponse	okResponse(byte[] data, java.lang.String contentType)
void	setAuthHandler(MaximoAuthenticator maxAuthHandler)
void	setCorrelator(MXCorrelator correlator)
void	setLogger(MXLogger logger)
void	setMethod(java.lang.String method)
void	setPathTokens(java.util.List pathTokens)
void	setRequestData(byte[] resourceBytes)
void	setResReqPath(java.lang.String resourceReq)
void	setRouteInfo(RouteInfo routeInfo)
protected void	validateTransactionId(java.sql.Connection conn, java.lang.String txid, java.lang.String osName)

Methods inherited from class java.lang.Object

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

Field Detail

routeInfo

protected RouteInfo routeInfo

resPath

protected java.util.List resPath

logger

protected MXLogger logger

correlator

protected MXCorrelator correlator

provider

protected java.lang.String provider

requestData

protected byte[] requestData

resourceReq

protected java.lang.String resourceReq

maxAuthHandler

protected MaximoAuthenticator maxAuthHandler

httpMethod

protected java.lang.String httpMethod

Constructor Detail

AbstractRouteHandler

public AbstractRouteHandler()

Method Detail

setRouteInfo

public void setRouteInfo(RouteInfo routeInfo)

isMonitorRouteAllowed

public boolean isMonitorRouteAllowed()

setMethod

public void setMethod(java.lang.String method)

authenticateRequest

public MXSession authenticateRequest(OslcRequest request)
                              throws MXException,
                                     java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

setAuthHandler

public void setAuthHandler(MaximoAuthenticator maxAuthHandler)

okResponse

protected OslcResourceResponse okResponse()

okJSONResponse

protected OslcResourceResponse okJSONResponse(byte[] data)

errorJSONResponse

protected OslcResourceResponse errorJSONResponse(com.ibm.json.java.JSONObject jo,
                                                 int status)
                                          throws MXException

Throws:

MXException

errorResponse

protected OslcResourceResponse errorResponse(byte[] respData,
                                             int status,
                                             java.lang.String respContentType)
                                      throws MXException

Throws:

MXException

acceptedResponse

protected OslcResourceResponse acceptedResponse(java.lang.String location)

okJSONResponse

protected OslcResourceResponse okJSONResponse(com.ibm.json.java.JSONArtifact ja)
                                       throws MXException

Throws:

MXException

okJSONResponse

protected OslcResourceResponse okJSONResponse(com.ibm.json.java.JSONObject ja)
                                       throws MXException

Throws:

MXException

okJSONResponse

protected OslcResourceResponse okJSONResponse(com.ibm.json.java.JSONArray ja)
                                       throws MXException

Throws:

MXException

okJSONResponse

protected OslcResourceResponse okJSONResponse(OslcResourceResponse data)

okResponse

protected OslcResourceResponse okResponse(byte[] data,
                                          java.lang.String contentType)

checkAuth

protected void checkAuth(UserInfo userInfo,
                         java.lang.String optionName,
                         java.lang.String context)
                  throws java.rmi.RemoteException,
                         MXException

Throws:

java.rmi.RemoteException

MXException

setResReqPath

public void setResReqPath(java.lang.String resourceReq)

setPathTokens

public void setPathTokens(java.util.List pathTokens)

getProvider

public java.lang.String getProvider()

setLogger

public void setLogger(MXLogger logger)

setCorrelator

public void setCorrelator(MXCorrelator correlator)

getRequestDataAsBytes

protected byte[] getRequestDataAsBytes()
                                throws MXException

Throws:

MXException

getRequestDataAsJSON

protected com.ibm.json.java.JSONArtifact getRequestDataAsJSON()
                                                       throws MXException

Throws:

MXException

getRequestDataAsJSONObject

protected com.ibm.json.java.JSONObject getRequestDataAsJSONObject()
                                                           throws MXException

Throws:

MXException

getRequestDataAsJSONArray

protected com.ibm.json.java.JSONArray getRequestDataAsJSONArray()
                                                         throws MXException

Throws:

MXException

getRequestDataAsText

protected java.lang.String getRequestDataAsText()
                                         throws MXException

Throws:

MXException

addCorrelationData

protected void addCorrelationData(java.lang.String label,
                                  java.lang.String dataItem)

correlateResponseDataSize

protected void correlateResponseDataSize(byte[] resourceRep)

logTransaction

protected void logTransaction(OslcRequest request,
                              java.lang.Long mboId,
                              MXTransaction mxTran)
                       throws MXException,
                              java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

validateTransactionId

protected void validateTransactionId(java.sql.Connection conn,
                                     java.lang.String txid,
                                     java.lang.String osName)
                              throws MXException

Throws:

MXException

handleRequest

public abstract OslcResourceResponse handleRequest(OslcRequest request)
                                            throws MXException,
                                                   java.io.IOException

Throws:

MXException

java.io.IOException

getPathTokensMeta

public java.util.Map getPathTokensMeta()

getPathTokenAllowedValuesMeta

public java.util.Set getPathTokenAllowedValuesMeta(java.lang.String token)
                                            throws MXException,
                                                   java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

getQueryParamsMeta

public java.util.List getQueryParamsMeta(java.lang.String path)

booleanEnumSet

protected java.util.Set booleanEnumSet()

getQueryParamAllowedValuesMeta

public java.util.Set getQueryParamAllowedValuesMeta(java.lang.String qparam)
                                             throws java.rmi.RemoteException,
                                                    MXException

Throws:

java.rmi.RemoteException

MXException

setRequestData

public void setRequestData(byte[] resourceBytes)

isPathTokensOptional

public boolean isPathTokensOptional()