Package com.sun.identity.authentication.spi

Class MetadataCallback

java.lang.Object

com.sun.identity.authentication.spi.MetadataCallback

All Implemented Interfaces:

Callback

@Supported
public class MetadataCallback
extends Object
implements Callback

A callback that allows some extra metadata to be sent in the response.

When serialized as JSON in an authenticate response, the outputValue object will be the value of a single data output value, so for a value of { "foo": "bar" }, this would be output as:

 
 {
     "authId": "...",
     "callbacks": [
         // ...
         {
             "type": "MetadataCallback",
             "output": [
                 {
                     "name": "data",
                     "value": {
                         "foo": "bar"
                     }
                 }
             ]
         }
     ]
 }
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MetadataCallback.Builder	A builder for the MetadataCallback.

Method Summary

Modifier and Type	Method	Description
static MetadataCallback.Builder	builder()	Get a builder for constructing a new MetadataCallback.
JsonValue	getOutputValue()	Get the output for the callback.

Methods inherited from class java.lang.Object

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

Method Details

getOutputValue

@Supported
public JsonValue getOutputValue()

Get the output for the callback.

Returns:

The output value.

builder

@Supported
public static MetadataCallback.Builder builder()

Get a builder for constructing a new MetadataCallback.

Returns:

The builder.