Package org.kohsuke.stapler.interceptor

Annotation Interface JsonOutputFilter

@Retention(RUNTIME)
@Target({METHOD,FIELD})
@InterceptorAnnotation(Processor.class)
public @interface JsonOutputFilter

Annotation for filtering the JSON data returned from a JavaScriptMethod annotated method. Put this annotation on your js proxied method and provide the properties you want filtered.

Author:

Robert Sandell <sandell.robert@gmail.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonOutputFilter.FilterPropertyFilter	Json Property filter for handling the include and exclude.
static class	JsonOutputFilter.Processor

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	excludes	Black-list of properties to exclude from the output.
boolean	ignoreDefaultExcludes	If JsonConfig.DEFAULT_EXCLUDES should be ignored.
boolean	ignoreTransient	If transient fields should be ignored.
String[]	includes	White-list of properties to include in the output.

Element Details

includes

String[] includes

White-list of properties to include in the output.

Default:

{}

excludes

String[] excludes

Black-list of properties to exclude from the output.

Default:

{}

ignoreTransient

boolean ignoreTransient

If transient fields should be ignored. Default true.

See Also:

• JsonConfig.isIgnoreTransientFields()

Default:

true

ignoreDefaultExcludes

boolean ignoreDefaultExcludes

If JsonConfig.DEFAULT_EXCLUDES should be ignored. Default false

See Also:

• JsonConfig.isIgnoreDefaultExcludes()

Default:

false