org.picketlink.idm.jpa.annotations.CredentialProperty Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
*
* Copyright 2013 Red Hat, Inc. and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.picketlink.idm.jpa.annotations;
import java.lang.annotation.Documented;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Specifies that a property should be mapped to a specific field of a {@link org.picketlink.idm.credential.storage.CredentialStorage}.
*
* @author Shane Bryzak
* @author Pedro Igor
*/
@Target({METHOD, FIELD})
@Documented
@Retention(RUNTIME)
@Inherited
public @interface CredentialProperty {
/**
* (Optional) The field from the corresponding {@link org.picketlink.idm.credential.storage.CredentialStorage} class
* that is mapped to this property.
* If no name is provided, the property name will be used to match the corresponding field on the storage class.
*
*
* @return
*/
String name() default "";
}