lumis.portal.documentation

Class DocumentationResource

java.lang.Object

lumis.portal.documentation.DocumentationResource

@Path(value="/lum-internal/documentation")
public class DocumentationResource
extends Object

Documentation utilities methods.

Since:

10.0.0

Version:

$Revision: 20151 $ $Date: 2017-04-26 16:14:10 +0000 (Wed, 26 Apr 2017) $

Constructor Summary

Constructors

Constructor and Description
DocumentationResource()

Method Summary

Modifier and Type	Method and Description
Response	goTo(String page, String locale) Redirects user to the desired page in the online documentation.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentationResource

public DocumentationResource()

Method Detail

goTo

@Path(value="/goTo/{page:[a-zA-Z0-9_.]+}")
 @GET
public Response goTo(@PathParam(value="page")
                                                                      String page,
                                                                      @QueryParam(value="locale")
                                                                      String locale)
                                                               throws PortalException

Redirects user to the desired page in the online documentation.

Parameters:

page - the requested documentation page.

locale - the optional locale.

Returns:

the response.

Throws:

PortalException

Since:

10.0.0