org.graylog2.rest.resources.system

Class GrokResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog2.rest.resources.system.GrokResource

@Path(value="/system/grok")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public class GrokResource
extends RestResource

Field Summary

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

configuration, userService

Constructor Summary

Constructors

Constructor and Description
GrokResource(GrokPatternService grokPatternService, PaginatedGrokPatternService paginatedGrokPatternService)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	bulkUpdatePatterns(@NotNull GrokPatternList patternList, boolean replace)
javax.ws.rs.core.Response	bulkUpdatePatternsFromTextFile(@NotNull InputStream patternsFile, boolean replace)
javax.ws.rs.core.Response	createPattern(@Valid @NotNull GrokPattern pattern)
PaginatedResponse<GrokPattern>	getPage(int page, int perPage, String query, String sort, String order)
GrokPatternList	listGrokPatterns() Deprecated.
GrokPattern	listPattern(String patternId)
void	removePattern(String patternId)
javax.ws.rs.core.Response	testPattern(GrokPatternTestRequest request)
GrokPattern	updatePattern(String patternId, GrokPattern pattern)

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

GrokResource

@Inject
public GrokResource(GrokPatternService grokPatternService,
                            PaginatedGrokPatternService paginatedGrokPatternService)

Method Detail

listGrokPatterns

@GET
 @Timed
 @Deprecated
public GrokPatternList listGrokPatterns()

Deprecated.

getPage

@GET
 @Timed
 @Path(value="/paginated")
 @Produces(value="application/json")
public PaginatedResponse<GrokPattern> getPage(@QueryParam(value="page") @DefaultValue(value="1")
                                                                                                                           int page,
                                                                                                                           @QueryParam(value="per_page") @DefaultValue(value="50")
                                                                                                                           int perPage,
                                                                                                                           @QueryParam(value="query") @DefaultValue(value="")
                                                                                                                           String query,
                                                                                                                           @DefaultValue(value="name") @QueryParam(value="sort")
                                                                                                                           String sort,
                                                                                                                           @DefaultValue(value="asc") @QueryParam(value="order")
                                                                                                                           String order)

listPattern

@GET
 @Timed
 @Path(value="/{patternId}")
public GrokPattern listPattern(@PathParam(value="patternId")
                                                                         String patternId)
                                                                  throws NotFoundException

Throws:

NotFoundException

testPattern

@POST
 @Timed
 @Path(value="/test")
public javax.ws.rs.core.Response testPattern(GrokPatternTestRequest request)

createPattern

@POST
 @Timed
public javax.ws.rs.core.Response createPattern(@Valid @NotNull
                                                             @Valid @NotNull GrokPattern pattern)
                                                      throws ValidationException

Throws:

ValidationException

bulkUpdatePatterns

@PUT
 @Timed
public javax.ws.rs.core.Response bulkUpdatePatterns(@NotNull
                                                                 @NotNull GrokPatternList patternList,
                                                                 @QueryParam(value="replace") @DefaultValue(value="false")
                                                                 boolean replace)
                                                          throws ValidationException

Throws:

ValidationException

bulkUpdatePatternsFromTextFile

@POST
 @Consumes(value="text/plain")
 @Timed
public javax.ws.rs.core.Response bulkUpdatePatternsFromTextFile(@NotNull
                                                                                                             @NotNull InputStream patternsFile,
                                                                                                             @QueryParam(value="replace") @DefaultValue(value="false")
                                                                                                             boolean replace)
                                                                                                      throws ValidationException,
                                                                                                             IOException

Throws:

ValidationException

IOException

updatePattern

@PUT
 @Timed
 @Path(value="/{patternId}")
public GrokPattern updatePattern(@PathParam(value="patternId")
                                                                           String patternId,
                                                                           GrokPattern pattern)
                                                                    throws ValidationException

Throws:

ValidationException

removePattern

@DELETE
 @Timed
 @Path(value="/{patternId}")
public void removePattern(@PathParam(value="patternId")
                                                                       String patternId)
                                                                throws NotFoundException

Throws:

NotFoundException