com.ibm.tivoli.maximo.oslc.provider

Class OslcYamlGenerator

java.lang.Object

com.ibm.tivoli.maximo.oslc.provider.OslcYamlGenerator

public class OslcYamlGenerator
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
OslcYamlGenerator()
OslcYamlGenerator(java.lang.String tags)
OslcYamlGenerator(UserInfo userInfo)
OslcYamlGenerator(UserInfo userInfo, java.lang.String tags)

Method Summary

Modifier and Type	Method and Description
protected void	addActions(java.lang.String osName)
protected void	addSavedQueryFromCache(java.lang.String osName)
protected void	addYamlDefDetailsDescription(OslcYaml oslcYaml, java.lang.String defName, java.lang.String description)
protected void	addYamlDefDetailsProperties(java.lang.String defName, java.lang.String propertyName, java.lang.String type, java.lang.String format, java.lang.String description, java.lang.String defaultValue, com.ibm.json.java.JSONArray enumValue, java.lang.String refObj, OslcYaml oslcYaml)
protected void	addYamlDefDetailsRequired(OslcYaml oslcYaml, java.lang.String defName, java.lang.String[] requiredProperties)
protected void	addYamlDefErrorModel(OslcYaml oslcYaml)
protected void	addYamlDefs(OslcYaml oslcYaml, java.lang.String osName)
protected void	addYamlMethodParams(java.lang.String ref, java.lang.String pathName, java.lang.String methodName, OslcYaml oslcYaml)
protected void	addYamlMethodParams(java.lang.String in, java.lang.String name, java.lang.String type, java.lang.String required, java.lang.String description, java.lang.String pathName, java.lang.String methodName, OslcYaml oslcYaml)
protected void	addYamlMethodParamsSystem(java.lang.String ref, java.lang.String pathName, java.lang.String methodName, OslcYaml oslcYaml)
protected void	addYamlParams(OslcYaml oslcYaml)
protected void	addYamlParams2Yaml(OslcYaml oslcYaml)
protected void	addYamlParamsAction(OslcYaml oslcYaml, java.lang.String osName, java.lang.String method, boolean isResource, MosInfo mosInfo)
protected com.ibm.json.java.JSONObject	addYamlParamsDetail(java.lang.String in, java.lang.String name, java.lang.String type, java.lang.String required, java.lang.String description, java.lang.String paramName, java.lang.String defaultValue, com.ibm.json.java.JSONObject schema, com.ibm.json.java.JSONArray enumValue, OslcYaml oslcYaml)
protected void	addYamlParamsRequired(java.util.List list)
protected void	addYamlParamsSavedQuery(OslcYaml oslcYaml, java.lang.String osName, java.lang.String method)
protected static java.lang.String	capitalizeFirstLetter(java.lang.String string)
byte[]	generateJson()
byte[]	generateYaml()
java.lang.String	generateYamlString()
com.ibm.json.java.JSONObject	getParamsObject()
java.util.List	getParamsObjectSource(java.lang.String methodName)
java.util.List	getResponseObjectSource(java.lang.String methodName)
void	paramsObjectSourceBuilder(java.lang.String methodName, java.util.List paramsList)
static com.ibm.json.java.JSONObject	readFromStream(java.lang.String path, java.lang.String filename)
protected void	setAttachment(java.lang.String osName, OslcYaml oslcYaml)
protected void	setDeleteOSResourceAttahchment(java.lang.String osName, OslcYaml oslcYaml)
protected void	setDeleteResource(java.lang.String osName, OslcYaml oslcYaml)
protected void	setGetOS(java.lang.String osName, OslcYaml oslcYaml)
protected void	setGetOSResource(java.lang.String osName, OslcYaml oslcYaml, MosInfo mosInfo)
protected void	setGetOSResourceAttahchment(java.lang.String osName, OslcYaml oslcYaml)
protected void	setGetOSResourceAttahchmentMeta(java.lang.String osName, OslcYaml oslcYaml)
protected void	setGetOSResourceChildObject(OslcResourceInfo oslcRes, java.lang.String osName, OslcYaml oslcYaml)
void	setGetOSResourceChildObjectSet(OslcResourceInfo oslcRes, java.lang.String osName, OslcYaml oslcYaml)
protected void	setPostOS(java.lang.String osName, OslcYaml oslcYaml, MosInfo mosInfo)
protected void	setPostOSResource(java.lang.String osName, OslcYaml oslcYaml, MosInfo mosInfo)
protected void	setPostOSResourceAttahchment(java.lang.String osName, OslcYaml oslcYaml)
protected com.ibm.json.java.JSONObject	statusContent(java.lang.String code, java.lang.String osName)
protected com.ibm.json.java.JSONObject	yamlParamsDetailBuilder(java.lang.String in, java.lang.String name, java.lang.String type, java.lang.String required, java.lang.String description, java.lang.String paramName, java.lang.String defaultValue, com.ibm.json.java.JSONObject schema, com.ibm.json.java.JSONArray enumValue, OslcYaml oslcYaml)
protected com.ibm.json.java.JSONObject	yamlRespDetailBuilder(java.lang.String description, com.ibm.json.java.JSONObject schema, com.ibm.json.java.JSONObject headers, com.ibm.json.java.JSONObject examples)

Methods inherited from class java.lang.Object

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

Constructor Detail

OslcYamlGenerator

public OslcYamlGenerator()
                  throws MXException

Throws:

MXException

OslcYamlGenerator

public OslcYamlGenerator(UserInfo userInfo)
                  throws MXException

Throws:

MXException

OslcYamlGenerator

public OslcYamlGenerator(java.lang.String tags)
                  throws MXException

Throws:

MXException

OslcYamlGenerator

public OslcYamlGenerator(UserInfo userInfo,
                         java.lang.String tags)
                  throws MXException

Throws:

MXException

Method Detail

getParamsObject

public com.ibm.json.java.JSONObject getParamsObject()

paramsObjectSourceBuilder

public void paramsObjectSourceBuilder(java.lang.String methodName,
                                      java.util.List paramsList)

getParamsObjectSource

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

getResponseObjectSource

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

generateYaml

public byte[] generateYaml()
                    throws MXException,
                           java.rmi.RemoteException,
                           java.io.UnsupportedEncodingException

Throws:

MXException

java.rmi.RemoteException

java.io.UnsupportedEncodingException

generateYamlString

public java.lang.String generateYamlString()
                                    throws MXException,
                                           java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

generateJson

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

Throws:

MXException

java.rmi.RemoteException

addYamlMethodParams

protected void addYamlMethodParams(java.lang.String in,
                                   java.lang.String name,
                                   java.lang.String type,
                                   java.lang.String required,
                                   java.lang.String description,
                                   java.lang.String pathName,
                                   java.lang.String methodName,
                                   OslcYaml oslcYaml)

addYamlMethodParams

protected void addYamlMethodParams(java.lang.String ref,
                                   java.lang.String pathName,
                                   java.lang.String methodName,
                                   OslcYaml oslcYaml)

addYamlMethodParamsSystem

protected void addYamlMethodParamsSystem(java.lang.String ref,
                                         java.lang.String pathName,
                                         java.lang.String methodName,
                                         OslcYaml oslcYaml)

addYamlDefs

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

addYamlParams

protected void addYamlParams(OslcYaml oslcYaml)
                      throws MXException

Throws:

MXException

addYamlParamsAction

protected void addYamlParamsAction(OslcYaml oslcYaml,
                                   java.lang.String osName,
                                   java.lang.String method,
                                   boolean isResource,
                                   MosInfo mosInfo)
                            throws MXException,
                                   java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

addYamlParamsSavedQuery

protected void addYamlParamsSavedQuery(OslcYaml oslcYaml,
                                       java.lang.String osName,
                                       java.lang.String method)
                                throws MXException

Throws:

MXException

readFromStream

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

Throws:

MXException

addYamlParamsDetail

protected com.ibm.json.java.JSONObject addYamlParamsDetail(java.lang.String in,
                                                           java.lang.String name,
                                                           java.lang.String type,
                                                           java.lang.String required,
                                                           java.lang.String description,
                                                           java.lang.String paramName,
                                                           java.lang.String defaultValue,
                                                           com.ibm.json.java.JSONObject schema,
                                                           com.ibm.json.java.JSONArray enumValue,
                                                           OslcYaml oslcYaml)

yamlParamsDetailBuilder

protected com.ibm.json.java.JSONObject yamlParamsDetailBuilder(java.lang.String in,
                                                               java.lang.String name,
                                                               java.lang.String type,
                                                               java.lang.String required,
                                                               java.lang.String description,
                                                               java.lang.String paramName,
                                                               java.lang.String defaultValue,
                                                               com.ibm.json.java.JSONObject schema,
                                                               com.ibm.json.java.JSONArray enumValue,
                                                               OslcYaml oslcYaml)

yamlRespDetailBuilder

protected com.ibm.json.java.JSONObject yamlRespDetailBuilder(java.lang.String description,
                                                             com.ibm.json.java.JSONObject schema,
                                                             com.ibm.json.java.JSONObject headers,
                                                             com.ibm.json.java.JSONObject examples)

addYamlParamsRequired

protected void addYamlParamsRequired(java.util.List list)

addYamlParams2Yaml

protected void addYamlParams2Yaml(OslcYaml oslcYaml)

addYamlDefErrorModel

protected void addYamlDefErrorModel(OslcYaml oslcYaml)

addYamlDefDetailsProperties

protected void addYamlDefDetailsProperties(java.lang.String defName,
                                           java.lang.String propertyName,
                                           java.lang.String type,
                                           java.lang.String format,
                                           java.lang.String description,
                                           java.lang.String defaultValue,
                                           com.ibm.json.java.JSONArray enumValue,
                                           java.lang.String refObj,
                                           OslcYaml oslcYaml)

addYamlDefDetailsRequired

protected void addYamlDefDetailsRequired(OslcYaml oslcYaml,
                                         java.lang.String defName,
                                         java.lang.String[] requiredProperties)

addYamlDefDetailsDescription

protected void addYamlDefDetailsDescription(OslcYaml oslcYaml,
                                            java.lang.String defName,
                                            java.lang.String description)

statusContent

protected com.ibm.json.java.JSONObject statusContent(java.lang.String code,
                                                     java.lang.String osName)

setGetOS

protected void setGetOS(java.lang.String osName,
                        OslcYaml oslcYaml)
                 throws MXException

Throws:

MXException

setGetOSResource

protected void setGetOSResource(java.lang.String osName,
                                OslcYaml oslcYaml,
                                MosInfo mosInfo)
                         throws java.rmi.RemoteException,
                                MXException

Throws:

java.rmi.RemoteException

MXException

setPostOS

protected void setPostOS(java.lang.String osName,
                         OslcYaml oslcYaml,
                         MosInfo mosInfo)
                  throws MXException,
                         java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

setPostOSResource

protected void setPostOSResource(java.lang.String osName,
                                 OslcYaml oslcYaml,
                                 MosInfo mosInfo)
                          throws MXException,
                                 java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

setDeleteResource

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

setGetOSResourceChildObjectSet

public void setGetOSResourceChildObjectSet(OslcResourceInfo oslcRes,
                                           java.lang.String osName,
                                           OslcYaml oslcYaml)

setGetOSResourceChildObject

protected void setGetOSResourceChildObject(OslcResourceInfo oslcRes,
                                           java.lang.String osName,
                                           OslcYaml oslcYaml)

setGetOSResourceAttahchment

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

setPostOSResourceAttahchment

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

setDeleteOSResourceAttahchment

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

setGetOSResourceAttahchmentMeta

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

setAttachment

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

addActions

protected void addActions(java.lang.String osName)

addSavedQueryFromCache

protected void addSavedQueryFromCache(java.lang.String osName)
                               throws java.rmi.RemoteException,
                                      MXException

Throws:

java.rmi.RemoteException

MXException

capitalizeFirstLetter

protected static java.lang.String capitalizeFirstLetter(java.lang.String string)