com.ibm.tivoli.oslc

Class OslcYaml

java.lang.Object

com.ibm.tivoli.oslc.OslcYaml

public class OslcYaml
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
OslcYaml()

Method Summary

Modifier and Type	Method and Description
boolean	addActionSchemaToComponent(java.lang.String actionName, com.ibm.json.java.JSONObject actionSchema)
OslcYaml	addDefinitionsDescription(java.lang.String defName, java.lang.String description)
OslcYaml	addDefinitionsProperties(java.lang.String defName, java.lang.String propertyName, com.ibm.json.java.JSONObject definitions)
OslcYaml	addDefinitionsRequired(java.lang.String defName, com.ibm.json.java.JSONArray requiredArr)
OslcYaml	addExternalDocs()
OslcYaml	addMethodBasicInfo(java.lang.String pathName, java.lang.String methodName, java.lang.String summary, java.lang.String description)
OslcYaml	addMethodConsumes(java.lang.String pathName, java.lang.String methodName, java.lang.String[] consumes)
OslcYaml	addMethodDeprecated()
OslcYaml	addMethodExternalDocs()
OslcYaml	addMethodOperationId()
OslcYaml	addMethodOperationId(java.lang.String pathName, java.lang.String methodName, java.lang.String id)
OslcYaml	addMethodParams(java.lang.String pathName, java.lang.String methodName, com.ibm.json.java.JSONObject params)
OslcYaml	addMethodPatternedObject()
OslcYaml	addMethodProduces(java.lang.String pathName, java.lang.String methodName, java.lang.String[] produces)
OslcYaml	addMethodRequestBody(java.lang.String pathName, java.lang.String methodName, com.ibm.json.java.JSONObject body)
OslcYaml	addMethodRequestBodyContent(java.lang.String pathName, java.lang.String methodName, java.lang.String contentType, com.ibm.json.java.JSONObject params)
OslcYaml	addMethodResponse(java.lang.String pathName, java.lang.String methodName, java.lang.String status, com.ibm.json.java.JSONObject statusContent)
OslcYaml	addMethodResponseForOS(java.lang.String pathName, java.lang.String methodName, java.lang.String status, com.ibm.json.java.JSONObject statusContent, boolean osSchemaAdded, java.lang.String osName, boolean isResource)
OslcYaml	addMethodSchemes(java.lang.String pathName, java.lang.String methodName, java.lang.String[] schemes)
OslcYaml	addMethodTags(java.lang.String pathName, java.lang.String methodName, java.lang.String[] tags)
boolean	addOSSchemaToComponent(java.lang.String osName, UserInfo userInfo)
OslcYaml	addParameters(java.lang.String paramName, com.ibm.json.java.JSONObject parameters)
OslcYaml	addResponses(java.lang.String paramName, com.ibm.json.java.JSONObject parameters)
OslcYaml	addSecurity(java.lang.String key, java.lang.Object scope)
OslcYaml	addSecurityDefinitions()
OslcYaml	addSecuritySchemes(java.lang.String key, java.lang.Object schemes)
OslcYaml	addTags()
protected com.ibm.json.java.JSONObject	findByPathMethodDetail(java.lang.String pathName, java.lang.String methodName)
com.ibm.json.java.JSONObject	getJSON()
java.lang.String	getYaml()
static java.lang.String	getYamlfromJSON(com.ibm.json.java.JSONObject object)
static void	jsonPrettyPrinter(java.lang.Object object)
static void	main(java.lang.String[] args)
OslcYaml	setBasePath(java.lang.String basePath)
OslcYaml	setConsumes(java.lang.String[] consumes)
OslcYaml	setHost(java.lang.String host)
OslcYaml	setHost(java.lang.String host, int port)
OslcYaml	setInfo(java.lang.String title, java.lang.String description, java.lang.String version)
OslcYaml	setInfoContact(java.lang.Object contactInfo)
OslcYaml	setInfoLicense(java.lang.Object licenseIfo)
OslcYaml	setInfoTermsOfService(java.lang.String tos)
void	setIsJson(boolean isJson)
OslcYaml	setOpenAPIVersion(java.lang.String openAPIVersion)
void	setParamBasicInfo(com.ibm.json.java.JSONObject param, java.lang.String in, java.lang.String name, java.lang.String description, java.lang.String required, java.lang.String type)
OslcYaml	setPatternedObject(java.lang.String patternName, java.lang.Object content) patternName must start with x-
OslcYaml	setSchemes(java.lang.String[] strs) Deprecated.
OslcYaml	setServer(com.ibm.json.java.JSONObject server)
OslcYaml	setSwaggerVersion(java.lang.String swaggerVersion)

Methods inherited from class java.lang.Object

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

Constructor Detail

OslcYaml

public OslcYaml()

Method Detail

setSwaggerVersion

public OslcYaml setSwaggerVersion(java.lang.String swaggerVersion)

setOpenAPIVersion

public OslcYaml setOpenAPIVersion(java.lang.String openAPIVersion)

setInfo

public OslcYaml setInfo(java.lang.String title,
                        java.lang.String description,
                        java.lang.String version)

setInfoTermsOfService

public OslcYaml setInfoTermsOfService(java.lang.String tos)

setInfoContact

public OslcYaml setInfoContact(java.lang.Object contactInfo)

setInfoLicense

public OslcYaml setInfoLicense(java.lang.Object licenseIfo)

setPatternedObject

public OslcYaml setPatternedObject(java.lang.String patternName,
                                   java.lang.Object content)

patternName must start with x-

Parameters:

patternName -

content -

Returns:

setHost

public OslcYaml setHost(java.lang.String host)

setHost

public OslcYaml setHost(java.lang.String host,
                        int port)

setSchemes

@Deprecated
public OslcYaml setSchemes(java.lang.String[] strs)

Deprecated.

addSecuritySchemes

public OslcYaml addSecuritySchemes(java.lang.String key,
                                   java.lang.Object schemes)

addSecurity

public OslcYaml addSecurity(java.lang.String key,
                            java.lang.Object scope)

setBasePath

public OslcYaml setBasePath(java.lang.String basePath)

setServer

public OslcYaml setServer(com.ibm.json.java.JSONObject server)

setConsumes

public OslcYaml setConsumes(java.lang.String[] consumes)

findByPathMethodDetail

protected com.ibm.json.java.JSONObject findByPathMethodDetail(java.lang.String pathName,
                                                              java.lang.String methodName)

addActionSchemaToComponent

public boolean addActionSchemaToComponent(java.lang.String actionName,
                                          com.ibm.json.java.JSONObject actionSchema)
                                   throws java.rmi.RemoteException,
                                          MXException

Throws:

java.rmi.RemoteException

MXException

addOSSchemaToComponent

public boolean addOSSchemaToComponent(java.lang.String osName,
                                      UserInfo userInfo)
                               throws java.rmi.RemoteException,
                                      MXException

Throws:

java.rmi.RemoteException

MXException

addMethodBasicInfo

public OslcYaml addMethodBasicInfo(java.lang.String pathName,
                                   java.lang.String methodName,
                                   java.lang.String summary,
                                   java.lang.String description)

addMethodOperationId

public OslcYaml addMethodOperationId(java.lang.String pathName,
                                     java.lang.String methodName,
                                     java.lang.String id)

addMethodProduces

public OslcYaml addMethodProduces(java.lang.String pathName,
                                  java.lang.String methodName,
                                  java.lang.String[] produces)

addMethodTags

public OslcYaml addMethodTags(java.lang.String pathName,
                              java.lang.String methodName,
                              java.lang.String[] tags)

addMethodParams

public OslcYaml addMethodParams(java.lang.String pathName,
                                java.lang.String methodName,
                                com.ibm.json.java.JSONObject params)

addMethodRequestBody

public OslcYaml addMethodRequestBody(java.lang.String pathName,
                                     java.lang.String methodName,
                                     com.ibm.json.java.JSONObject body)

addMethodRequestBodyContent

public OslcYaml addMethodRequestBodyContent(java.lang.String pathName,
                                            java.lang.String methodName,
                                            java.lang.String contentType,
                                            com.ibm.json.java.JSONObject params)

addMethodResponse

public OslcYaml addMethodResponse(java.lang.String pathName,
                                  java.lang.String methodName,
                                  java.lang.String status,
                                  com.ibm.json.java.JSONObject statusContent)

addMethodResponseForOS

public OslcYaml addMethodResponseForOS(java.lang.String pathName,
                                       java.lang.String methodName,
                                       java.lang.String status,
                                       com.ibm.json.java.JSONObject statusContent,
                                       boolean osSchemaAdded,
                                       java.lang.String osName,
                                       boolean isResource)

addMethodExternalDocs

public OslcYaml addMethodExternalDocs()

addMethodOperationId

public OslcYaml addMethodOperationId()

addMethodConsumes

public OslcYaml addMethodConsumes(java.lang.String pathName,
                                  java.lang.String methodName,
                                  java.lang.String[] consumes)

addMethodSchemes

public OslcYaml addMethodSchemes(java.lang.String pathName,
                                 java.lang.String methodName,
                                 java.lang.String[] schemes)

addMethodDeprecated

public OslcYaml addMethodDeprecated()

addMethodPatternedObject

public OslcYaml addMethodPatternedObject()

addDefinitionsProperties

public OslcYaml addDefinitionsProperties(java.lang.String defName,
                                         java.lang.String propertyName,
                                         com.ibm.json.java.JSONObject definitions)

addDefinitionsRequired

public OslcYaml addDefinitionsRequired(java.lang.String defName,
                                       com.ibm.json.java.JSONArray requiredArr)

addDefinitionsDescription

public OslcYaml addDefinitionsDescription(java.lang.String defName,
                                          java.lang.String description)

addParameters

public OslcYaml addParameters(java.lang.String paramName,
                              com.ibm.json.java.JSONObject parameters)

addResponses

public OslcYaml addResponses(java.lang.String paramName,
                             com.ibm.json.java.JSONObject parameters)

addSecurityDefinitions

public OslcYaml addSecurityDefinitions()

addTags

public OslcYaml addTags()

addExternalDocs

public OslcYaml addExternalDocs()

getJSON

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

getYaml

public java.lang.String getYaml()

setParamBasicInfo

public void setParamBasicInfo(com.ibm.json.java.JSONObject param,
                              java.lang.String in,
                              java.lang.String name,
                              java.lang.String description,
                              java.lang.String required,
                              java.lang.String type)

main

public static void main(java.lang.String[] args)

getYamlfromJSON

public static java.lang.String getYamlfromJSON(com.ibm.json.java.JSONObject object)

jsonPrettyPrinter

public static void jsonPrettyPrinter(java.lang.Object object)

setIsJson

public void setIsJson(boolean isJson)