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

Constructor Summary

Constructors

Constructor and Description
RamlHandler(ScheduledExecutorService executor, String ramlLocation, boolean keepApiBaseUri, org.mule.runtime.api.exception.ErrorTypeRepository errorTypeRepository, org.mule.parser.service.ParserMode parserMode)
RamlHandler(ScheduledExecutorService executor, String ramlLocation, boolean keepApiBaseUri, org.mule.runtime.api.exception.ErrorTypeRepository errorTypeRepository, org.mule.parser.service.ParserMode parserMode, boolean filterUnsupportedLogging)
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.parser.service.ParserMode parserMode)

Method Summary

Modifier and Type	Method and Description
String	dumpRaml()
String	getAMFModel()
org.mule.apikit.model.ApiSpecification	getApi()
org.mule.apikit.model.ApiVendor	getApiVendor()
String	getBaseUriReplacement(String apiServer)
String	getRamlV1()
String	getRamlV2(String resourceRelativePath)
String	getRootRamlLocationForV1()
String	getRootRamlLocationForV2()
String	getSuccessStatusCode(org.mule.apikit.model.Action 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.apikit.model.ApiSpecification api)
void	setApiServer(String apiServer)
void	writeAMFModel(String url, OutputStream outputStream)

Methods inherited from class java.lang.Object

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

Field Detail

APPLICATION_RAML

public static final String APPLICATION_RAML

See Also:

Constant Field Values

Constructor Detail

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.runtime.api.exception.ErrorTypeRepository errorTypeRepository,
                   org.mule.parser.service.ParserMode parserMode)
            throws IOException

Throws:

IOException

RamlHandler

public RamlHandler(ScheduledExecutorService executor,
                   String ramlLocation,
                   boolean keepApiBaseUri,
                   org.mule.runtime.api.exception.ErrorTypeRepository errorTypeRepository,
                   org.mule.parser.service.ParserMode parserMode)
            throws IOException

Throws:

IOException

RamlHandler

public RamlHandler(ScheduledExecutorService executor,
                   String ramlLocation,
                   boolean keepApiBaseUri,
                   org.mule.runtime.api.exception.ErrorTypeRepository errorTypeRepository,
                   org.mule.parser.service.ParserMode parserMode,
                   boolean filterUnsupportedLogging)
            throws IOException

Throws:

IOException

Method Detail

isParserV2

@Deprecated
public boolean isParserV2()

Deprecated. use getApiVendor() instead.

getApiVendor

public org.mule.apikit.model.ApiVendor getApiVendor()

getApi

public org.mule.apikit.model.ApiSpecification getApi()

setApi

public void setApi(org.mule.apikit.model.ApiSpecification 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()

writeAMFModel

public void writeAMFModel(String url,
                          OutputStream outputStream)

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.apikit.model.Action action)

setApiServer

public void setApiServer(String apiServer)