org.kohsuke.stapler.interceptor

Annotation Type JsonOutputFilter

@Retention(value=RUNTIME)
 @Target(value={METHOD,FIELD})
 @InterceptorAnnotation(value=JsonOutputFilter.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>

Optional Element Summary

Optional Elements

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

includes

public abstract String[] includes

White-list of properties to include in the output.

Default:

{}

excludes

public abstract String[] excludes

Black-list of properties to exclude from the output.

Default:

{}

ignoreTransient

public abstract boolean ignoreTransient

If transient fields should be ignored. Default true.

See Also:

JsonConfig.isIgnoreTransientFields()

Default:

true

ignoreDefaultExcludes

public abstract boolean ignoreDefaultExcludes

If JsonConfig.DEFAULT_EXCLUDES should be ignored. Default false

See Also:

JsonConfig.isIgnoreDefaultExcludes()

Default:

false