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(value="/api-browser")
public class DocumentationBrowserResource
extends RestResource

Field Summary

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

configuration, userService

Constructor Summary

Constructors

Constructor and Description
DocumentationBrowserResource(MimetypesFileTypeMap mimeTypes, HttpConfiguration httpConfiguration, com.floreysoft.jmte.Engine templateEngine)

Method Summary

Modifier and Type	Method and 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 Detail

DocumentationBrowserResource

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

Method Detail

root

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

Throws:

IOException

index

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

Throws:

IOException

allIndex

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

Throws:

IOException

asset

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

Throws:

IOException