com.ibm.tivoli.maximo.oslc.provider

Class OslcOASGenerator

java.lang.Object

com.ibm.tivoli.maximo.oslc.provider.OslcOASGenerator

public class OslcOASGenerator
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
OslcOASGenerator(UserInfo userInfo, OslcRequest request)

Method Summary

Modifier and Type	Method and Description
protected void	addYamlDefErrorModel(OslcYaml oslcYaml)
protected void	addYamlDefs(OslcYaml oslcYaml, java.lang.String osName) Add POST schema, need to clean up and discuss
protected void	addYamlParams2Yaml(OslcYaml oslcYaml)
protected void	addYamlParamsAction(java.lang.String path, java.lang.String method, boolean isResource, MosInfo mosInfo, com.ibm.json.java.JSONObject actionObject) Add actions to OSLCYAML
protected void	addYamlParamsFromFile() Read parameters library from yamlParamsSourceDocument file.
protected void	addYamlParamsSavedQuery(java.lang.String osName, java.lang.String method, com.ibm.json.java.JSONObject savedQueryObject) Add Saved Query to OSLCYAML
byte[]	generateJson()
java.util.List	getParamsObjectSource(java.lang.String methodName)
java.util.List	getResponseObjectSource(java.lang.String methodName)
protected com.ibm.json.java.JSONObject	loadActions(java.lang.String osName, MosInfo mosInfo, java.util.Map wsmethodMap) Load Actions from OSOSLCACTION, RESTSYSACTION, WSMETHODACTION.
protected void	loadOsOslcActions(java.lang.String osName, com.ibm.json.java.JSONArray resourcePostArray, com.ibm.json.java.JSONArray resourceGetArray, com.ibm.json.java.JSONArray collectionPostArray, com.ibm.json.java.JSONArray collectionGetArray) Load Actions from OSOSLCACTION, the action need to be registered in OS first
protected void	loadRestSysActions(java.lang.String osName, com.ibm.json.java.JSONArray resourcePostArray, com.ibm.json.java.JSONArray resourceGetArray, com.ibm.json.java.JSONArray collectionPostArray, com.ibm.json.java.JSONArray collectionGetArray) Load Actions from RESTSYSACTION.
protected com.ibm.json.java.JSONObject	loadSavedQuery(java.lang.String osName) Load SavedQuery from MaxSavedQueryProcessor { "queries": ["queryname1","queryname2"] "oasdescription": "description for yaml param" }
protected void	loadWSMethodActions(java.lang.String osName, com.ibm.json.java.JSONArray resourcePostArray, com.ibm.json.java.JSONArray resourceGetArray, com.ibm.json.java.JSONArray collectionPostArray, com.ibm.json.java.JSONArray collectionGetArray, MosInfo mosInfo, java.util.Map wsmethodObject) Load Actions from WSMETHOD, defined in service class
static com.ibm.json.java.JSONObject	readFromStream(java.lang.String path, java.lang.String filename)
protected void	setApiRouteMethod()
protected void	setAttachment(java.lang.String osName, java.lang.String osTag, OslcResourceDetailInfo osDetailInfo, MosInfo mosInfo)
protected void	setCommonOASActionMethod(java.lang.String ostag, java.lang.String actionCategory, java.lang.String baseCategroy, java.lang.String httpMethodName, boolean isResource)
protected void	setCommonOSAction()
protected void	setDeleteOSResourceAttachment(java.lang.String path, java.lang.String osTag)
protected void	setDeleteResource(java.lang.String osName, java.lang.String osTag)
protected void	setGetOSResourceAttachment(java.lang.String osName, java.lang.String osTag)
protected void	setGetOSResourceAttachmentMeta(java.lang.String path, java.lang.String osTag)
protected void	setGetOSResourceChildObject(java.util.Map oslcRelatedResources, java.lang.String osName, java.lang.String osTag)
protected void	setOASActionMethod(java.lang.String osName, java.lang.String ostag, MosInfo mosInfo, java.lang.String actionCategory, java.lang.String baseCategroy, java.lang.String httpMethodName, boolean isResource, java.util.Map wsmethodMap)
protected void	setPostOS(java.lang.String osName, java.lang.String osTag, MosInfo mosInfo, com.ibm.json.java.JSONObject actionObject, boolean osSchemaAdded)
protected void	setPostOSResource(java.lang.String osName, java.lang.String osTag, MosInfo mosInfo, com.ibm.json.java.JSONObject actionObject, boolean osSchemaAdded)
protected void	setPostOSResourceAttachment(java.lang.String path, java.lang.String osTag)

Methods inherited from class java.lang.Object

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

Constructor Detail

OslcOASGenerator

public OslcOASGenerator(UserInfo userInfo,
                        OslcRequest request)
                 throws MXException

Throws:

MXException

Method Detail

generateJson

public byte[] generateJson()
                    throws MXException,
                           java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

addYamlDefs

protected void addYamlDefs(OslcYaml oslcYaml,
                           java.lang.String osName)

Add POST schema, need to clean up and discuss

Parameters:

oslcYaml -

osName -

addYamlParamsFromFile

protected void addYamlParamsFromFile()
                              throws MXException

Read parameters library from yamlParamsSourceDocument file.

Parameters:

oslcYaml -

Throws:

MXException

addYamlParamsAction

protected void addYamlParamsAction(java.lang.String path,
                                   java.lang.String method,
                                   boolean isResource,
                                   MosInfo mosInfo,
                                   com.ibm.json.java.JSONObject actionObject)
                            throws MXException,
                                   java.rmi.RemoteException

Add actions to OSLCYAML

Parameters:

osName -

method -

isResource -

mosInfo -

actionObject -

Throws:

MXException

java.rmi.RemoteException

addYamlParamsSavedQuery

protected void addYamlParamsSavedQuery(java.lang.String osName,
                                       java.lang.String method,
                                       com.ibm.json.java.JSONObject savedQueryObject)
                                throws MXException

Add Saved Query to OSLCYAML

Parameters:

osName -

method -

savedQueryObject -

Throws:

MXException

readFromStream

public static com.ibm.json.java.JSONObject readFromStream(java.lang.String path,
                                                          java.lang.String filename)
                                                   throws MXException

Throws:

MXException

addYamlParams2Yaml

protected void addYamlParams2Yaml(OslcYaml oslcYaml)

addYamlDefErrorModel

protected void addYamlDefErrorModel(OslcYaml oslcYaml)

setPostOS

protected void setPostOS(java.lang.String osName,
                         java.lang.String osTag,
                         MosInfo mosInfo,
                         com.ibm.json.java.JSONObject actionObject,
                         boolean osSchemaAdded)
                  throws MXException,
                         java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

setPostOSResource

protected void setPostOSResource(java.lang.String osName,
                                 java.lang.String osTag,
                                 MosInfo mosInfo,
                                 com.ibm.json.java.JSONObject actionObject,
                                 boolean osSchemaAdded)
                          throws MXException,
                                 java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

setDeleteResource

protected void setDeleteResource(java.lang.String osName,
                                 java.lang.String osTag)

setGetOSResourceChildObject

protected void setGetOSResourceChildObject(java.util.Map oslcRelatedResources,
                                           java.lang.String osName,
                                           java.lang.String osTag)

setGetOSResourceAttachment

protected void setGetOSResourceAttachment(java.lang.String osName,
                                          java.lang.String osTag)

setPostOSResourceAttachment

protected void setPostOSResourceAttachment(java.lang.String path,
                                           java.lang.String osTag)

setDeleteOSResourceAttachment

protected void setDeleteOSResourceAttachment(java.lang.String path,
                                             java.lang.String osTag)

setGetOSResourceAttachmentMeta

protected void setGetOSResourceAttachmentMeta(java.lang.String path,
                                              java.lang.String osTag)

setAttachment

protected void setAttachment(java.lang.String osName,
                             java.lang.String osTag,
                             OslcResourceDetailInfo osDetailInfo,
                             MosInfo mosInfo)
                      throws MXException

Throws:

MXException

loadActions

protected com.ibm.json.java.JSONObject loadActions(java.lang.String osName,
                                                   MosInfo mosInfo,
                                                   java.util.Map wsmethodMap)

Load Actions from OSOSLCACTION, RESTSYSACTION, WSMETHODACTION. Currently we load resource GET/POST, and collection POST for BULK childCollection or childResource can be added in the future due to requirement. action is stored as string for now, for the future requirement, we can save it as object. { "collection": { "GET": [], "POST": [], "description": "Description" }, "resource": { "GET": ["getaciton1","getaction2"], "POST": ["postaciton1","postaciton2"] } }

Parameters:

osName -

mosInfo -

Returns:

JSONObject

loadOsOslcActions

protected void loadOsOslcActions(java.lang.String osName,
                                 com.ibm.json.java.JSONArray resourcePostArray,
                                 com.ibm.json.java.JSONArray resourceGetArray,
                                 com.ibm.json.java.JSONArray collectionPostArray,
                                 com.ibm.json.java.JSONArray collectionGetArray)

Load Actions from OSOSLCACTION, the action need to be registered in OS first

Parameters:

osName -

resourcePostArray -

resourceGetArray -

collectionPostArray -

collectionGetArray -

loadRestSysActions

protected void loadRestSysActions(java.lang.String osName,
                                  com.ibm.json.java.JSONArray resourcePostArray,
                                  com.ibm.json.java.JSONArray resourceGetArray,
                                  com.ibm.json.java.JSONArray collectionPostArray,
                                  com.ibm.json.java.JSONArray collectionGetArray)

Load Actions from RESTSYSACTION.

Parameters:

osName -

resourcePostArray -

resourceGetArray -

collectionPostArray -

collectionGetArray -

loadWSMethodActions

protected void loadWSMethodActions(java.lang.String osName,
                                   com.ibm.json.java.JSONArray resourcePostArray,
                                   com.ibm.json.java.JSONArray resourceGetArray,
                                   com.ibm.json.java.JSONArray collectionPostArray,
                                   com.ibm.json.java.JSONArray collectionGetArray,
                                   MosInfo mosInfo,
                                   java.util.Map wsmethodObject)

Load Actions from WSMETHOD, defined in service class

Parameters:

osName -

resourcePostArray -

resourceGetArray -

collectionPostArray -

collectionGetArray -

mosInfo -

loadSavedQuery

protected com.ibm.json.java.JSONObject loadSavedQuery(java.lang.String osName)
                                               throws java.rmi.RemoteException,
                                                      MXException

Load SavedQuery from MaxSavedQueryProcessor { "queries": ["queryname1","queryname2"] "oasdescription": "description for yaml param" }

Parameters:

osName -

Returns:

JSONObject

Throws:

java.rmi.RemoteException

MXException

getParamsObjectSource

public java.util.List getParamsObjectSource(java.lang.String methodName)

getResponseObjectSource

public java.util.List getResponseObjectSource(java.lang.String methodName)

setOASActionMethod

protected void setOASActionMethod(java.lang.String osName,
                                  java.lang.String ostag,
                                  MosInfo mosInfo,
                                  java.lang.String actionCategory,
                                  java.lang.String baseCategroy,
                                  java.lang.String httpMethodName,
                                  boolean isResource,
                                  java.util.Map wsmethodMap)
                           throws MXException,
                                  java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

setCommonOSAction

protected void setCommonOSAction()
                          throws MXException,
                                 java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

setCommonOASActionMethod

protected void setCommonOASActionMethod(java.lang.String ostag,
                                        java.lang.String actionCategory,
                                        java.lang.String baseCategroy,
                                        java.lang.String httpMethodName,
                                        boolean isResource)
                                 throws MXException,
                                        java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

setApiRouteMethod

protected void setApiRouteMethod()
                          throws MXException,
                                 java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException