Package com.sun.enterprise.config.serverbeans

Interface SecurityService

All Superinterfaces:
org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag
public interface SecurityService extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag
The security service element defines parameters and configuration information needed by the core Jakarta 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.

  • Method Details

    • getDefaultRealm

      String getDefaultRealm()
      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.

      Returns:
      possible object is String

    • setDefaultRealm

      void setDefaultRealm(String defaultRealm) throws PropertyVetoException
      Sets the value of the defaultRealm property.
      Parameters:
      defaultRealm - allowed object is String
      Throws:
      PropertyVetoException

    • getDefaultPrincipal

      String getDefaultPrincipal()
      Gets the value of the defaultPrincipal property.

      Used as the identity of default security contexts when necessary and no principal is provided.

      Returns:
      possible object is String

    • setDefaultPrincipal

      void setDefaultPrincipal(String defaultPrincipal) throws PropertyVetoException
      Sets the value of the defaultPrincipal property.
      Parameters:
      defaultPrincipal - allowed object is String
      Throws:
      PropertyVetoException

    • getDefaultPrincipalPassword

      String getDefaultPrincipalPassword()
      Gets the value of the defaultPrincipalPassword property.

      Password of default principal.

      Returns:
      possible object is String

    • setDefaultPrincipalPassword

      void setDefaultPrincipalPassword(String defaultPrincipalPassword) throws PropertyVetoException
      Sets the value of the defaultPrincipalPassword property.
      Parameters:
      defaultPrincipalPassword - allowed object is String
      Throws:
      PropertyVetoException

    • getAnonymousRole

      String getAnonymousRole()
      Deprecated.
      This attribute is deprecated.
      Gets the value of the anonymousRole property.
      Returns:
      possible object is String

    • setAnonymousRole

      void setAnonymousRole(String anonymousRole) throws PropertyVetoException
      Sets the value of the anonymousRole property.
      Parameters:
      anonymousRole - allowed object is String
      Throws:
      PropertyVetoException

    • getAuditEnabled

      String getAuditEnabled()
      Gets the value of the auditEnabled property.

      If true, additional access logging is performed to provide audit information.

      Returns:
      possible object is String

    • setAuditEnabled

      void setAuditEnabled(String auditEnabled) throws PropertyVetoException
      Sets the value of the auditEnabled property.
      Parameters:
      auditEnabled - allowed object is String
      Throws:
      PropertyVetoException

    • getJacc

      String getJacc()
      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.

      Returns:
      possible object is String

    • setJacc

      void setJacc(String jacc) throws PropertyVetoException
      Sets the value of the jacc property.
      Parameters:
      jacc - allowed object is String
      Throws:
      PropertyVetoException

    • getAuditModules

      String getAuditModules()
      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.

      Returns:
      possible object is String

    • setAuditModules

      void setAuditModules(String auditModules) throws PropertyVetoException
      Sets the value of the auditModules property.
      Parameters:
      auditModules - allowed object is String
      Throws:
      PropertyVetoException

    • getActivateDefaultPrincipalToRoleMapping

      String getActivateDefaultPrincipalToRoleMapping()
      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 Principal implementation class (see mapped-principal-class). This behavior is similar to that of Tomcat servlet container. It is off by default.

      Returns:
      possible object is String

    • setActivateDefaultPrincipalToRoleMapping

      void setActivateDefaultPrincipalToRoleMapping(String principalToRoleMapping) throws PropertyVetoException
      Sets the value of the activateDefaultPrincipalToRoleMapping property.
      Parameters:
      principalToRoleMapping - allowed object is String
      Throws:
      PropertyVetoException

    • getMappedPrincipalClass

      String getMappedPrincipalClass()
      Customizes the 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 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 Principal is used. The value of this attribute is only relevant when the activate-default principal-to-role-mapping attribute is set to true.

      Returns:
      possible object is String

    • setMappedPrincipalClass

      void setMappedPrincipalClass(String mappedPrincipalClass) throws PropertyVetoException
      Sets the value of the mappedPrincipalClass property.
      Parameters:
      mappedPrincipalClass - allowed object is String
      Throws:
      PropertyVetoException

    • getAuthRealm

      List<AuthRealm> getAuthRealm()
      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 AuthRealm

    • getJaccProvider

      List<JaccProvider> getJaccProvider()
      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 JaccProvider

    • getAuditModule

      List<AuditModule> getAuditModule()
      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 AuditModule

    • getMessageSecurityConfig

      List<MessageSecurityConfig> getMessageSecurityConfig()
      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 MessageSecurityConfig

    • getProperty

      @ToDo(priority=IMPORTANT, details="Provide PropertyDesc for legal props") @PropertiesDesc(props={}) List<org.jvnet.hk2.config.types.Property> getProperty()
      Properties as per PropertyBag
      Specified by:
      getProperty in interface org.jvnet.hk2.config.types.PropertyBag