Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> securityfilter >> [ config overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.securityfilter.config
Class SecurityConfig  

java.lang.Object
  org.securityfilter.config.SecurityConfig

---

public class SecurityConfig

extends java.lang.Object

SecurityConfig gathers information from the security-config.xml file to be used by the filter.

Version:

$Revision: 1.13 $ $Date: 2003/10/25 11:58:55 $

---

Field Summary
private  java.lang.String	authMethod
private  java.lang.String	defaultPage
private  java.lang.String	errorPage
private  java.lang.Object	lastRealm
private  java.lang.String	loginPage
private  org.securityfilter.realm.SecurityRealmInterface	realm
private  java.lang.String	realmName
private  java.util.ArrayList	securityConstraints
private  boolean	validating

 

Constructor Summary

SecurityConfig(boolean validating)           Constructor that takes the validating flag and debug level to be used while parsing.

 

Method Summary
void	addRealm(java.lang.Object realm)           Adds a realm to use for authentication.
void	addSecurityConstraint(SecurityConstraint constraint)           Adds a SecurityConstraint.
java.lang.String	getAuthMethod()           Get the authentication method being used to challenge the user.
java.lang.String	getDefaultPage()           Return the default page URL.
java.lang.String	getErrorPage()           Return the error page URL.
java.lang.String	getLoginPage()           Return the login page URL.
org.securityfilter.realm.SecurityRealmInterface	getRealm()           Return the realm to use for authentication.
java.lang.String	getRealmName()           Get the authentication realm name.
java.util.List	getSecurityConstraints()           Return the configured SecurityConstraints.
void	loadConfig(java.net.URL configURL)           Loads configuration from the specifued configURL.
protected  void	registerLocalDTDs(org.apache.commons.digester.Digester digester)           Register local copies of the SecurityFilter DTD files.
void	setAuthMethod(java.lang.String authMethod)           Set the authentication method being used to challenge the user.
void	setDefaultPage(java.lang.String defaultPage)           Set the default page URL.
void	setErrorPage(java.lang.String errorPage)           Set the error page URL.
void	setLoginPage(java.lang.String loginPage)           Set the login page URL.
void	setRealmName(java.lang.String realmName)           Set the authentication realm name.

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

loginPage

private java.lang.String loginPage

---

errorPage

private java.lang.String errorPage

---

defaultPage

private java.lang.String defaultPage

---

securityConstraints

private java.util.ArrayList securityConstraints

---

realm

private org.securityfilter.realm.SecurityRealmInterface realm

---

lastRealm

private java.lang.Object lastRealm

---

validating

private boolean validating

---

authMethod

private java.lang.String authMethod

---

realmName

private java.lang.String realmName

Constructor Detail

SecurityConfig

public SecurityConfig(boolean validating)

Constructor that takes the validating flag and debug level to be used while parsing.

Method Detail

getLoginPage

public java.lang.String getLoginPage()

Return the login page URL.

---

setLoginPage

public void setLoginPage(java.lang.String loginPage)

Set the login page URL. This is the page the user will be sent to to log in (i.e. the login form).

---

getErrorPage

public java.lang.String getErrorPage()

Return the error page URL.

---

setErrorPage

public void setErrorPage(java.lang.String errorPage)

Set the error page URL. This is the page the user will be sent to if login request fails.

---

getDefaultPage

public java.lang.String getDefaultPage()

Return the default page URL.

---

setDefaultPage

public void setDefaultPage(java.lang.String defaultPage)

Set the default page URL. This is the page the user will be sent to if they submit a login request without being forced to the login page by the filter.

---

getAuthMethod

public java.lang.String getAuthMethod()

Get the authentication method being used to challenge the user. Currently, only BASIC and FORM based are supported.

---

setAuthMethod

public void setAuthMethod(java.lang.String authMethod)

Set the authentication method being used to challenge the user. Currently, only BASIC and FORM based are supported.

---

getRealmName

public java.lang.String getRealmName()

Get the authentication realm name. This is used for BASIC authentication.

---

setRealmName

public void setRealmName(java.lang.String realmName)

Set the authentication realm name. This is used for BASIC authentication.

---

getRealm

public org.securityfilter.realm.SecurityRealmInterface getRealm()

Return the realm to use for authentication. This is the outer-most realm if nested realms are used. The outer-most realm must be listed first in the configuration file.

---

addRealm

public void addRealm(java.lang.Object realm)
              throws java.lang.NoSuchMethodException,
                     java.lang.IllegalAccessException,
                     java.lang.reflect.InvocationTargetException

Adds a realm to use for authentication. The first time this method is called, the realm must implement SecurityRealmInterface. Subsequent calls can be any kind of object, and setRealm(realm) will be called on the last realm passed to this method. This allows nesting of realms for caching or when a realm adapter is used.

---

getSecurityConstraints

public java.util.List getSecurityConstraints()

Return the configured SecurityConstraints.

---

addSecurityConstraint

public void addSecurityConstraint(SecurityConstraint constraint)

Adds a SecurityConstraint.

---

loadConfig

public void loadConfig(java.net.URL configURL)
                throws java.io.IOException,
                       org.xml.sax.SAXException

Loads configuration from the specifued configURL.

---

registerLocalDTDs

protected void registerLocalDTDs(org.apache.commons.digester.Digester digester)

Register local copies of the SecurityFilter DTD files.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> securityfilter >> [ config overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---