Package org.graylog2.shared.rest.resources.documentation

Class DocumentationBrowserResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog2.shared.rest.resources.documentation.DocumentationBrowserResource

@Path("/api-browser")
public class DocumentationBrowserResource
extends RestResource

Field Summary

Fields inherited from class org.graylog2.shared.rest.resources.RestResource

userService

Constructor Summary

Constructors

Constructor	Description
DocumentationBrowserResource(javax.activation.MimetypesFileTypeMap mimeTypes, HttpConfiguration httpConfiguration, com.floreysoft.jmte.Engine templateEngine, Configuration configuration)

Method Summary

Modifier and Type	Method	Description
String	allIndex(javax.ws.rs.core.HttpHeaders httpHeaders)
javax.ws.rs.core.Response	asset(String route)
String	index(javax.ws.rs.core.HttpHeaders httpHeaders)
javax.ws.rs.core.Response	root(javax.ws.rs.core.HttpHeaders httpHeaders)

Methods inherited from class org.graylog2.shared.rest.resources.RestResource

checkAnyPermission, checkPermission, checkPermission, getCurrentUser, getIndexSet, getSubject, getUriBuilderToSelf, isAnyPermitted, isAnyPermitted, isPermitted, isPermitted, setPrettyPrint

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentationBrowserResource

@Inject
public DocumentationBrowserResource(javax.activation.MimetypesFileTypeMap mimeTypes,
 HttpConfiguration httpConfiguration,
 com.floreysoft.jmte.Engine templateEngine,
 Configuration configuration)

Method Details

root

@GET
public javax.ws.rs.core.Response root(@Context
 javax.ws.rs.core.HttpHeaders httpHeaders)
                               throws IOException

Throws:

IOException

index

@GET
@Produces("text/html")
@Path("index.html")
public String index(@Context
 javax.ws.rs.core.HttpHeaders httpHeaders)
             throws IOException

Throws:

IOException

allIndex

@GET
@Produces("text/html")
@Path("/global/index.html")
public String allIndex(@Context
 javax.ws.rs.core.HttpHeaders httpHeaders)
                throws IOException

Throws:

IOException

asset

@GET
@Path("/{route: .*}")
public javax.ws.rs.core.Response asset(@PathParam("route")
 String route)
                                throws IOException

Throws:

IOException