org.opensaml.storage.annotation

Class AnnotationSupport

java.lang.Object

org.opensaml.storage.annotation.AnnotationSupport

public final class AnnotationSupport
extends java.lang.Object

Support class that reads and writes fields decorated with storage annotations.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Map<java.lang.String,java.lang.reflect.Field>	FIELD_CACHE Simple cache of fields we have seen.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	AnnotationSupport() Private constructor of utility class.

Method Summary

Modifier and Type	Method and Description
private static <T extends java.lang.annotation.Annotation> T	getAnnotation(java.lang.Object target, java.lang.Class<T> annotationType) Returns an annotation of a specified type attached to a target object.
static java.lang.String	getContext(java.lang.Object target) Gets the value of the field indicated by the Context annotation on the given object.
static java.lang.Long	getExpiration(java.lang.Object target) Gets the value of the field indicated by the Expiration annotation on the given object, or null if none.
private static java.lang.reflect.Field	getField(java.lang.Object target, java.lang.String fieldName) Returns a Field from a target object.
private static java.lang.Object	getFieldValue(java.lang.Object target, java.lang.String fieldName) Returns the value of a field from an object using reflection.
static java.lang.String	getKey(java.lang.Object target) Gets the value of the field indicated by the Key annotation on the given object.
static java.lang.String	getValue(java.lang.Object target) Gets the value of the field indicated by the Value annotation on the given object.
static void	setContext(java.lang.Object target, java.lang.String context) Sets the value of the field indicated by the Context annotation on the given object.
static void	setExpiration(java.lang.Object target, java.lang.Long expiration) Sets the value of the field indicated by the Expiration annotation on the given object.
private static void	setFieldValue(java.lang.Object target, java.lang.String fieldName, java.lang.Object fieldValue) Returns the value of a field from an object using reflection.
static void	setKey(java.lang.Object target, java.lang.String key) Sets the value of the field indicated by the Key annotation on the given object.
static void	setValue(java.lang.Object target, java.lang.String value) Sets the value of the field indicated by the Value annotation on the given object.

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_CACHE

private static final java.util.Map<java.lang.String,java.lang.reflect.Field> FIELD_CACHE

Simple cache of fields we have seen.

Constructor Detail

AnnotationSupport

private AnnotationSupport()

Private constructor of utility class.

Method Detail

getContext

@Nonnull
 @NotEmpty
public static java.lang.String getContext(@Nonnull
                                                              java.lang.Object target)

Gets the value of the field indicated by the Context annotation on the given object.

If the value is not a String, then it is converted to one by calling Object.toString() on the object.

Parameters:

target - object from which to get context

Returns:

Context field value

Throws:

java.lang.IllegalArgumentException - if the target object doesn't declare a Context annotation

java.lang.RuntimeException - if the field cannot be read on the target object

setContext

public static void setContext(@Nonnull
                              java.lang.Object target,
                              @Nonnull @NotEmpty
                              java.lang.String context)

Sets the value of the field indicated by the Context annotation on the given object.

Parameters:

target - Object on which to set context

context - Context value

Throws:

java.lang.IllegalArgumentException - if the target object doesn't declare a Context annotation

java.lang.RuntimeException - if the field cannot be set on the target object

getKey

@Nonnull
 @NotEmpty
public static java.lang.String getKey(@Nonnull
                                                          java.lang.Object target)

Gets the value of the field indicated by the Key annotation on the given object.

If the value is not a String, then it is converted to one by calling Object.toString() on the object.

Parameters:

target - object from which to get key

Returns:

Key field value

Throws:

java.lang.IllegalArgumentException - if the target object doesn't declare a Key annotation

java.lang.RuntimeException - if the field cannot be read on the target object

setKey

public static void setKey(@Nonnull
                          java.lang.Object target,
                          @Nonnull @NotEmpty
                          java.lang.String key)

Sets the value of the field indicated by the Key annotation on the given object.

Parameters:

target - Object on which to set key

key - Key value

Throws:

java.lang.IllegalArgumentException - if the target object doesn't declare a Key annotation

java.lang.RuntimeException - if the field cannot be set on the target object

getValue

@Nonnull
 @NotEmpty
public static java.lang.String getValue(@Nonnull
                                                            java.lang.Object target)

Gets the value of the field indicated by the Value annotation on the given object.

If the value is not a String, then it is converted to one by calling Object.toString() on the object.

Parameters:

target - Object from which to get value

Returns:

Value field value

Throws:

java.lang.IllegalArgumentException - if the target object doesn't declare a Value annotation

java.lang.RuntimeException - if the field cannot be read on the target object

setValue

public static void setValue(@Nonnull
                            java.lang.Object target,
                            @Nonnull @NotEmpty
                            java.lang.String value)

Sets the value of the field indicated by the Value annotation on the given object.

Parameters:

target - object on which to set value

value - Value field value

Throws:

java.lang.IllegalArgumentException - if the target object doesn't declare a Value annotation

java.lang.RuntimeException - if the field cannot be set on the target object

getExpiration

@Nullable
public static java.lang.Long getExpiration(@Nonnull
                                                     java.lang.Object target)

Gets the value of the field indicated by the Expiration annotation on the given object, or null if none.

The value is returned as a long, in milliseconds since the beginning of the Unix epoch. The following data types are supported:

• long
• Date
• ReadableInstant

Parameters:

target - Object from which to get expiration

Returns:

Expiration field value, or null

Throws:

java.lang.IllegalArgumentException - if the target object doesn't declare a Expiration annotation

java.lang.RuntimeException - if the field cannot be read on the target object or if it is an unsupported data type

setExpiration

public static void setExpiration(@Nonnull
                                 java.lang.Object target,
                                 @Nullable
                                 java.lang.Long expiration)

Sets the value of the field indicated by the Expiration annotation on the given object.

The expiration is expressed in milliseconds since the beginning of the Unix epoch. The following data types are supported:

• long
• Date
• ReadableInstant

Parameters:

target - object on which to set expiration

expiration - value to set

Throws:

java.lang.IllegalArgumentException - if the target object doesn't declare a Expiration annotation

java.lang.RuntimeException - if the field cannot be set on the target object or if it is an unsupported data type

getAnnotation

@Nonnull
private static <T extends java.lang.annotation.Annotation> T getAnnotation(@Nonnull
                                                                                    java.lang.Object target,
                                                                                    @Nonnull
                                                                                    java.lang.Class<T> annotationType)

Returns an annotation of a specified type attached to a target object.

Type Parameters:

T - type of annotation

Parameters:

target - target object to examine

annotationType - class type of annotation to find

Returns:

the annotation found on the object

Throws:

java.lang.IllegalArgumentException - if the target object doesn't declare the annotation

getFieldValue

@Nullable
private static java.lang.Object getFieldValue(@Nonnull
                                                        java.lang.Object target,
                                                        @Nonnull
                                                        java.lang.String fieldName)

Returns the value of a field from an object using reflection.

Parameters:

target - target object to examine

fieldName - name of the field to retrieve

Returns:

the value of the field

Throws:

java.lang.RuntimeException - if the field cannot be read

setFieldValue

private static void setFieldValue(@Nonnull
                                  java.lang.Object target,
                                  @Nonnull
                                  java.lang.String fieldName,
                                  @Nullable
                                  java.lang.Object fieldValue)

Returns the value of a field from an object using reflection.

Parameters:

target - target object to update

fieldName - name of the field to set

fieldValue - value to set

Throws:

java.lang.RuntimeException - if the field cannot be set

getField

@Nonnull
private static java.lang.reflect.Field getField(@Nonnull
                                                         java.lang.Object target,
                                                         @Nonnull
                                                         java.lang.String fieldName)

Returns a Field from a target object.

Parameters:

target - target object to examine

fieldName - name of the field to retrieve

Returns:

the specified field from the object

Throws:

java.lang.RuntimeException - if the target object doesn't declare the annotation