org.mule.module.apikit.api

Class RamlHandler

java.lang.Object

org.mule.module.apikit.api.RamlHandler

public class RamlHandler
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_RAML
protected static org.slf4j.Logger	logger
static String	MULE_APIKIT_PARSER_AMF
static String	MULE_APIKIT_PARSER_PROPERTY

Constructor Summary

Constructors

Constructor and Description
RamlHandler(String ramlLocation, boolean keepApiBaseUri)
RamlHandler(String ramlLocation, boolean keepApiBaseUri, org.mule.runtime.api.exception.ErrorTypeRepository errorTypeRepository)
RamlHandler(String ramlLocation, boolean keepApiBaseUri, org.mule.runtime.api.exception.ErrorTypeRepository errorTypeRepository, org.mule.raml.interfaces.ParserType parserType)
RamlHandler(String ramlLocation, boolean keepApiBaseUri, org.mule.raml.interfaces.ParserType parserType)

Method Summary

Modifier and Type	Method and Description
String	dumpRaml()
String	getAMFModel()
org.mule.raml.interfaces.model.IRaml	getApi()
org.mule.raml.interfaces.model.ApiVendor	getApiVendor()
String	getBaseUriReplacement(String apiServer)
org.mule.raml.interfaces.ParserType	getParserType()
String	getRamlV1()
String	getRamlV2(String resourceRelativePath)
String	getRootRamlLocationForV1()
String	getRootRamlLocationForV2()
String	getSuccessStatusCode(org.mule.raml.interfaces.model.IAction action)
boolean	isParserV2() Deprecated. use getApiVendor() instead.
boolean	isRequestingRamlV1ForConsole(String listenerPath, String requestPath, String queryString, String method, String acceptHeader)
boolean	isRequestingRamlV2(String listenerPath, String requestPath, String queryString, String method)
void	setApi(org.mule.raml.interfaces.model.IRaml api)
void	setApiServer(String apiServer)

Methods inherited from class java.lang.Object

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

Field Detail

MULE_APIKIT_PARSER_PROPERTY

public static final String MULE_APIKIT_PARSER_PROPERTY

See Also:

Constant Field Values

APPLICATION_RAML

public static final String APPLICATION_RAML

See Also:

Constant Field Values

logger

protected static final org.slf4j.Logger logger

MULE_APIKIT_PARSER_AMF

public static final String MULE_APIKIT_PARSER_AMF

See Also:

Constant Field Values

Constructor Detail

RamlHandler

public RamlHandler(String ramlLocation,
                   boolean keepApiBaseUri)
            throws IOException

Throws:

IOException

RamlHandler

public RamlHandler(String ramlLocation,
                   boolean keepApiBaseUri,
                   org.mule.runtime.api.exception.ErrorTypeRepository errorTypeRepository)
            throws IOException

Throws:

IOException

RamlHandler

public RamlHandler(String ramlLocation,
                   boolean keepApiBaseUri,
                   org.mule.raml.interfaces.ParserType parserType)
            throws IOException

Throws:

IOException

RamlHandler

public RamlHandler(String ramlLocation,
                   boolean keepApiBaseUri,
                   org.mule.runtime.api.exception.ErrorTypeRepository errorTypeRepository,
                   org.mule.raml.interfaces.ParserType parserType)
            throws IOException

Throws:

IOException

Method Detail

getParserType

public org.mule.raml.interfaces.ParserType getParserType()

isParserV2

@Deprecated
public boolean isParserV2()

Deprecated. use getApiVendor() instead.

getApiVendor

public org.mule.raml.interfaces.model.ApiVendor getApiVendor()

getApi

public org.mule.raml.interfaces.model.IRaml getApi()

setApi

public void setApi(org.mule.raml.interfaces.model.IRaml api)

dumpRaml

public String dumpRaml()

getRamlV1

public String getRamlV1()

getRamlV2

public String getRamlV2(String resourceRelativePath)
                 throws org.mule.runtime.api.exception.TypedException

Throws:

org.mule.runtime.api.exception.TypedException

getAMFModel

public String getAMFModel()

getBaseUriReplacement

public String getBaseUriReplacement(String apiServer)

isRequestingRamlV1ForConsole

public boolean isRequestingRamlV1ForConsole(String listenerPath,
                                            String requestPath,
                                            String queryString,
                                            String method,
                                            String acceptHeader)

isRequestingRamlV2

public boolean isRequestingRamlV2(String listenerPath,
                                  String requestPath,
                                  String queryString,
                                  String method)

getRootRamlLocationForV2

public String getRootRamlLocationForV2()

getRootRamlLocationForV1

public String getRootRamlLocationForV1()

getSuccessStatusCode

public String getSuccessStatusCode(org.mule.raml.interfaces.model.IAction action)

setApiServer

public void setApiServer(String apiServer)