com.sun.enterprise.config.serverbeans.SecurityService Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
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.config.types.Property;
import java.beans.PropertyVetoException;
import java.util.List;
import org.glassfish.api.admin.config.PropertiesDesc;
import org.jvnet.hk2.config.types.PropertyBag;
import org.glassfish.quality.ToDo;
/**
* The security service element defines parameters and configuration information needed by the core J2EE security
* service. Some container-specific security configuration elements are in the various container configuration elements
* and not here. SSL configuration is also elsewhere. At this time the security service configuration consists of a set
* of authentication realms. A number of top-level attributes are defined as well
*
*/
/* @XmlType(name = "", propOrder = {
"authRealm",
"jaccProvider",
"auditModule",
"messageSecurityConfig",
"property"
}) */
@Configured
public interface SecurityService extends ConfigBeanProxy, PropertyBag {
/**
* Gets the value of the defaultRealm property.
*
* Specifies which realm (by name) is used by default when no realm is specifically requested. The file realm is the
* common default
*
* @return possible object is {@link String }
*/
@Attribute(defaultValue = "file")
public String getDefaultRealm();
/**
* Sets the value of the defaultRealm property.
*
* @param value allowed object is {@link String }
*/
public void setDefaultRealm(String value) throws PropertyVetoException;
/**
* Gets the value of the defaultPrincipal property.
*
* Used as the identity of default security contexts when necessary and no principal is provided
*
* @return possible object is {@link String }
*/
@Attribute
public String getDefaultPrincipal();
/**
* Sets the value of the defaultPrincipal property.
*
* @param value allowed object is {@link String }
*/
public void setDefaultPrincipal(String value) throws PropertyVetoException;
/**
* Gets the value of the defaultPrincipalPassword property.
*
* Password of default principal
*
* @return possible object is {@link String }
*/
@Attribute
public String getDefaultPrincipalPassword();
/**
* Sets the value of the defaultPrincipalPassword property.
*
* @param value allowed object is {@link String }
*/
public void setDefaultPrincipalPassword(String value) throws PropertyVetoException;
/**
* Gets the value of the anonymousRole property.
*
* This attribute is deprecated.
*
* @return possible object is {@link String }
*/
@Attribute(defaultValue = "AttributeDeprecated")
public String getAnonymousRole();
/**
* Sets the value of the anonymousRole property.
*
* @param value allowed object is {@link String }
*/
public void setAnonymousRole(String value) throws PropertyVetoException;
/**
* Gets the value of the auditEnabled property.
*
* If true, additional access logging is performed to provide audit information
*
* @return possible object is {@link String }
*/
@Attribute(defaultValue = "false", dataType = Boolean.class)
public String getAuditEnabled();
/**
* Sets the value of the auditEnabled property.
*
* @param value allowed object is {@link String }
*/
public void setAuditEnabled(String value) throws PropertyVetoException;
/**
* Gets the value of the jacc property. Specifies the name of the jacc-provider element to use for setting up the JACC
* infrastructure. The default value "default" does not need to be changed unless adding a custom JACC provider.
*
* @return possible object is {@link String }
*/
@Attribute(defaultValue = "default")
public String getJacc();
/**
* Sets the value of the jacc property.
*
* @param value allowed object is {@link String }
*/
public void setJacc(String value) throws PropertyVetoException;
/**
* Gets the value of the auditModules property.
*
* Optional list of audit provider modules which will be used by the audit subsystem. Default value refers to the
* internal log-based audit module
*
* @return possible object is {@link String }
*/
@Attribute(defaultValue = "default")
public String getAuditModules();
/**
* Sets the value of the auditModules property.
*
* @param value allowed object is {@link String }
*/
public void setAuditModules(String value) throws PropertyVetoException;
/**
* Gets the value of the activateDefaultPrincipalToRoleMapping property.
*
* Causes the appserver to apply a default principal to role mapping, to any application that does not have an
* application specific mapping defined. Every role is mapped to a same-named (as the role) instance of a
* java.security.Principal implementation class (see mapped-principal-class) This behavior is similar to that of Tomcat
* servlet container. It is off by default.
*
* @return possible object is {@link String }
*/
@Attribute(defaultValue = "true", dataType = Boolean.class)
public String getActivateDefaultPrincipalToRoleMapping();
/**
* Sets the value of the activateDefaultPrincipalToRoleMapping property.
*
* @param value allowed object is {@link String }
*/
public void setActivateDefaultPrincipalToRoleMapping(String value) throws PropertyVetoException;
/**
* Customizes the java.security.Principal implementation class used when activate-default-principal-to-role-mapping is
* set to true. Should the default be set to com.sun.enterprise.deployment.Group?
*
* This attribute is used to customize the java.security.Principal implementation class used in the default principal to
* role mapping. This attribute is optional. When it is not specified, com.sun.enterprise.deployment.Group
* implementation of java.security.Principal is used. The value of this attribute is only relevant when the
* activate-default principal-to-role-mapping attribute is set to true
*
* @return possible object is {@link String }
*/
@Attribute
public String getMappedPrincipalClass();
/**
* Sets the value of the mappedPrincipalClass property.
*
* @param value allowed object is {@link String }
*/
public void setMappedPrincipalClass(String value) throws PropertyVetoException;
/**
* Gets the value of the authRealm property.
*
*
* This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object. This is why there is not a set method for the
* authRealm property.
*
*
* For example, to add a new item, do as follows:
*
*
* getAuthRealm().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list {@link AuthRealm }
*/
@Element(required = true)
public List getAuthRealm();
/**
* Gets the value of the jaccProvider property.
*
*
* This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object. This is why there is not a set method for the
* jaccProvider property.
*
*
* For example, to add a new item, do as follows:
*
*
* getJaccProvider().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list {@link JaccProvider }
*/
@Element(required = true)
public List getJaccProvider();
/**
* Gets the value of the auditModule property.
*
*
* This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object. This is why there is not a set method for the
* auditModule property.
*
*
* For example, to add a new item, do as follows:
*
*
* getAuditModule().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list {@link AuditModule }
*/
@Element
public List getAuditModule();
/**
* Gets the value of the messageSecurityConfig property.
*
* Optional list of layer specific lists of configured message security providers.
*
*
*
* This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object. This is why there is not a set method for the
* messageSecurityConfig property.
*
*
* For example, to add a new item, do as follows:
*
*
* getMessageSecurityConfig().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list {@link MessageSecurityConfig }
*/
@Element
public List getMessageSecurityConfig();
/**
* Properties as per {@link PropertyBag}
*/
@ToDo(priority = ToDo.Priority.IMPORTANT, details = "Provide PropertyDesc for legal props")
@PropertiesDesc(props = {})
@Element
List getProperty();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy