SecurityProvider.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2012 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package org.glassfish.security.services.config;

import java.util.List;

import java.beans.PropertyVetoException;
import javax.validation.constraints.NotNull;

import org.jvnet.hk2.config.Attribute;
import org.jvnet.hk2.config.Configured;
import org.jvnet.hk2.config.ConfigBeanProxy;
import org.jvnet.hk2.config.Element;

/**
 * The configuration that is used by a security service to identify the
 * set of security providers which are created and consumed by the service. 
 */
@Configured
public interface SecurityProvider extends ConfigBeanProxy {
    /**
     * Gets the name of the security provider.
     * The name represents the qualifier @Named given to the security provider. 
     */
    @Attribute
    @NotNull
    public String getName();
    public void setName(String value) throws PropertyVetoException;

    /**
     * Gets the type of the security provider.
     * The type represents a String used by the security service for the security provider interface.
     */
    @Attribute(required=true)
    @NotNull
    String getType();
    void setType(String type) throws PropertyVetoException;

    /**
     * Gets the name of the security provider configuration instance.
     * The provider name is used to reference specific provider configuration objects.
     */
    @Attribute(required=true, key=true)
    @NotNull
    String getProviderName();
    void setProviderName(String name) throws PropertyVetoException;

    /**
     * Gets configuration object specific to the security provider implementation.
     * Security provider configuration must extend the SecurityProviderConfig interface.
     */
    @Element("*")
    List<SecurityProviderConfig> getSecurityProviderConfig();
}