Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 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 com.sun.enterprise.config.serverbeans;
import org.jvnet.hk2.config.Attribute;
import org.jvnet.hk2.config.Configured;
import org.jvnet.hk2.config.Element;
import org.jvnet.hk2.config.ConfigBeanProxy;
import org.jvnet.hk2.component.Injectable;
import java.beans.PropertyVetoException;
import java.util.List;
import org.glassfish.api.admin.config.PropertyDesc;
import org.glassfish.api.admin.config.PropertiesDesc;
import static org.glassfish.config.support.Constants.NAME_REGEX;
import org.jvnet.hk2.config.types.Property;
import org.jvnet.hk2.config.types.PropertyBag;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import com.sun.enterprise.config.serverbeans.customvalidators.JavaClassName;
/**
* The provider-config element defines the configuration of an authentication
* provider
*
* A provider-config with no contained request-policy or response-policy
* sub-elements, is a null provider. The container will not instantiate or
* invoke the methods of a null provider, and as such the implementation class
* of a null provider need not exist
*/
/* @XmlType(name = "", propOrder = {
"requestPolicy",
"responsePolicy",
"property"
}) */
@Configured
public interface ProviderConfig extends ConfigBeanProxy, Injectable, PropertyBag {
/**
* Gets the value of the providerId property.
*
* Identifier used to uniquely identify this provider-config element
*
* @return possible object is
* {@link String }
*/
@Attribute(key=true)
@Pattern(regexp=NAME_REGEX)
@NotNull
public String getProviderId();
/**
* Sets the value of the providerId property.
*
* @param value allowed object is
* {@link String }
*/
public void setProviderId(String value) throws PropertyVetoException;
/**
* Gets the value of the providerType property.
*
* Defines whether the provider is a client authentication provider or a
* server authentication provider.
*
* @return possible object is
* {@link String }
*/
@Attribute
@NotNull
@Pattern(regexp="(client|server|client-server)")
public String getProviderType();
/**
* Sets the value of the providerType property.
*
* @param value allowed object is
* {@link String }
*/
public void setProviderType(String value) throws PropertyVetoException;
/**
* Gets the value of the className property.
*
* Defines the java implementation class of the provider.
*
* Client authentication providers must implement the
* com.sun.enterprise.security.jauth.ClientAuthModule interface.
*
* Server-side providers must implement the
* com.sun.enterprise.security.jauth.ServerAuthModule interface.
*
* A provider may implement both interfaces, but it must implement the
* interface corresponding to its provider type.
*
* @return possible object is
* {@link String }
*/
@Attribute
@NotNull
@JavaClassName
public String getClassName();
/**
* Sets the value of the className property.
*
* @param value allowed object is
* {@link String }
*/
public void setClassName(String value) throws PropertyVetoException;
/**
* Gets the value of the requestPolicy property.
*
* Defines the authentication policy requirements associated with request
* processing performed by the authentication provider
*
* @return possible object is
* {@link RequestPolicy }
*/
@Element
public RequestPolicy getRequestPolicy();
/**
* Sets the value of the requestPolicy property.
*
* @param value allowed object is
* {@link RequestPolicy }
*/
public void setRequestPolicy(RequestPolicy value) throws PropertyVetoException;
/**
* Gets the value of the responsePolicy property.
*
* Defines the authentication policy requirements associated with the
* response processing performed by the authentication provider.
*
* @return possible object is
* {@link ResponsePolicy }
*/
@Element
public ResponsePolicy getResponsePolicy();
/**
* Sets the value of the responsePolicy property.
*
* @param value allowed object is
* {@link ResponsePolicy }
*/
public void setResponsePolicy(ResponsePolicy value) throws PropertyVetoException;
/**
Properties.
*/
@PropertiesDesc(
props={
@PropertyDesc(name="security.config", defaultValue="${com.sun.aas.instanceRoot}/config/wss-server-config-1.0.xml",
description="Specifies the location of the message security configuration file"),
@PropertyDesc(name="debug", defaultValue="false", dataType=Boolean.class,
description="Enables dumping of server provider debug messages to the server log"),
@PropertyDesc(name="dynamic.username.password", defaultValue="false", dataType=Boolean.class,
description="Signals the provider runtime to collect the user name and password from the " +
"CallbackHandler for each request. If false, the user name and password for wsse:UsernameToken(s) is " +
"collected once, during module initialization. Applicable only for a ClientAuthModule"),
@PropertyDesc(name="encryption.key.alias", defaultValue="s1as",
description="Specifies the encryption key used by the provider. The key is identified by its keystore alias"),
@PropertyDesc(name="signature.key.alias", defaultValue="s1as",
description="Specifies the signature key used by the provider. The key is identified by its keystore alias")
}
)
@Element
List getProperty();
}
