org.restlet.ext.raml

Class RamlApplication

java.lang.Object

org.restlet.Restlet

org.restlet.Application

org.restlet.ext.raml.RamlApplication

All Implemented Interfaces:

Uniform

Deprecated.

Will be removed in next minor release.

@Deprecated
public class RamlApplication
extends Application

RAML enabled application. This subclass of Application can describe itself in the format described by the RAML specification project.

It requires you to set up a specific end point that serves the RAML definition.

By default, nothing is required. This application adds to its inbound root the endpoint ("/raml"). You can override this behavior by using the RamlApplication#attachRaml* methods
By default, the description is generated by introspecting the application itself. You can override this behavior by specifying your own implementation of RamlSpecificationRestlet.

Author:

Cyprien Quilici

Constructor Summary

Constructors

Constructor and Description
RamlApplication() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	attachRamlDocumentationRestlet(Router router, java.lang.String ramlPath, Restlet ramlRestlet) Deprecated. Defines the route on which the Raml definition will be provided.
void	attachRamlSpecificationRestlet(Router router) Deprecated. Defines the route on which the RAML definition will be provided (by default, "/raml").
Restlet	getInboundRoot() Deprecated. Overrides the parent's implementation.
RamlSpecificationRestlet	getRamlSpecificationRestlet(Context context) Deprecated. The dedicated Restlet able to generate the RAML specification format.

Methods inherited from class org.restlet.Application

createInboundRoot, createOutboundRoot, getConnectorService, getConnegService, getConverterService, getCurrent, getDecoderService, getEncoderService, getMetadataService, getOutboundRoot, getRangeService, getRole, getRoles, getServices, getStatusService, getTaskService, getTunnelService, handle, isDebugging, setConnectorService, setConnegService, setContext, setConverterService, setCurrent, setDebugging, setDecoderService, setEncoderService, setInboundRoot, setInboundRoot, setMetadataService, setOutboundRoot, setOutboundRoot, setRangeService, setRoles, setStatusService, setTaskService, setTunnelService, start, stop

Methods inherited from class org.restlet.Restlet

createFinder, finalize, getApplication, getAuthor, getContext, getDescription, getFinderClass, getLogger, getName, getOwner, handle, handle, handle, isStarted, isStopped, setAuthor, setDescription, setFinderClass, setName, setOwner

Methods inherited from class java.lang.Object

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

Constructor Detail

RamlApplication

public RamlApplication()

Deprecated.

Method Detail

attachRamlDocumentationRestlet

public void attachRamlDocumentationRestlet(Router router,
                                           java.lang.String ramlPath,
                                           Restlet ramlRestlet)

Deprecated.

Defines the route on which the Raml definition will be provided.

Parameters:

router - The router on which defining the new route.

ramlPath - The path to which attach the Restlet that serves the RAML definition.

ramlRestlet - The Restlet that serves the RAML definition.

attachRamlSpecificationRestlet

public void attachRamlSpecificationRestlet(Router router)

Deprecated.

Defines the route on which the RAML definition will be provided (by default, "/raml").

Parameters:

router - The router on which defining the new route.

getInboundRoot

public Restlet getInboundRoot()

Deprecated.

Overrides the parent's implementation. It checks that the application has been documented using a RamlSpecificationRestlet. By default, the documentation is attached to the high level router, with the "/raml" path.

Overrides:

getInboundRoot in class Application

getRamlSpecificationRestlet

public RamlSpecificationRestlet getRamlSpecificationRestlet(Context context)

Deprecated.

The dedicated Restlet able to generate the RAML specification format.

Returns:

The Restlet able to generate the RAML specification format.