|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.nucleus.TimedOperationService atg.servlet.pipeline.PipelineableServletImpl atg.servlet.pipeline.BasicAuthenticationPipelineServlet
public class BasicAuthenticationPipelineServlet
This pipeline servlet implements Basic authentication. If the request comes in bearing an Authorization header with Basic authentication, then this servlet consults an Authenticator to see if the specified id/password is authenticated, and passes the request on if so. If not, then a challenge is issued using the specified realm property.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
BasicAuthenticationPipelineServlet()
Constructs a new BasicAuthenticaionPipelineServlet |
Method Summary | |
---|---|
void |
addNoWarnIfNonExistantLoginName(java.lang.String pLoginName)
Add a login name to the list of login names not warn for non-existant logins. |
void |
doStartService()
Initialize the prefix-to-authenticator correspondence arrays, if needed, on initialization. |
java.lang.String |
getAuthenticateHeaderValue()
Returns the header value for the authentication header |
Authenticator |
getAuthenticator()
Returns the authenticator used to verify id/password combinations |
boolean |
getEnabled()
Is authentication enabled? |
boolean |
getLogFailedAuthentications()
Retturns true if informational log messages will be emitted whenever authentication for the request fails, false if no logging will be performed. |
boolean |
getLogSuccessfulAuthentications()
Returns true if informational log messages will be emitted whenever a user is authenticated, false if no logging will be performed. |
java.lang.String[] |
getNoWarnIfNonexistantLoginNames()
The array of login names not warn for non-existant logins. |
ServiceMap |
getPathAuthenticatorMap()
Gets the path authenticator map. |
java.lang.String |
getRealm()
Returns the realm that will be displayed to the user in the authentication request. |
java.lang.String |
getUnauthorizedMessage()
Returns the HTML message that will be displayed to the user if authentication fails. |
boolean |
removeNoWarnIfNonExistantLoginName(java.lang.String pLoginName)
Remove a login name from the list of login names not warn for non-existant logins. |
void |
service(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Services a DynamoHttpServletRequest/Response pair |
void |
setAuthenticator(Authenticator pAuthenticator)
Sets the authenticator used to verify id/password combinations |
void |
setEnabled(boolean pEnabled)
Returns the enabled flag for authentication. |
void |
setLogFailedAuthentications(boolean pDoLog)
If true, informational log messages will be emitted whenever authentication for the request fails. |
void |
setLogSuccessfulAuthentications(boolean pDoLog)
If set to true, informational log messages will be emitted whenever a user is authenticated. |
void |
setNoWarnIfNonexistantLoginNames(java.lang.String[] pNoWarnIfNonexistantLoginNames)
The array of login names not warn for non-existant logins. |
void |
setPathAuthenticatorMap(ServiceMap pMap)
Sets the path authenticator map. |
void |
setRealm(java.lang.String pRealm)
Sets the realm that will be displayed to the user in the authentication request. |
void |
setUnauthorizedMessage(java.lang.String pUnauthorizedMessage)
Sets the HTML message that will be displayed to the user if authentication fails. |
Methods inherited from class atg.servlet.pipeline.PipelineableServletImpl |
---|
createAdminServlet, destroy, getAdminServlet, getNextServlet, getServletConfig, getServletInfo, init, isUsePathInfo, passRequest, passRequest, service, service, setNextServlet, setServletInfo, setUsePathInfo |
Methods inherited from class atg.nucleus.TimedOperationService |
---|
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public BasicAuthenticationPipelineServlet()
Method Detail |
---|
public java.lang.String getRealm()
public void setRealm(java.lang.String pRealm)
public java.lang.String getAuthenticateHeaderValue()
public void setNoWarnIfNonexistantLoginNames(java.lang.String[] pNoWarnIfNonexistantLoginNames)
public java.lang.String[] getNoWarnIfNonexistantLoginNames()
public void addNoWarnIfNonExistantLoginName(java.lang.String pLoginName)
public boolean removeNoWarnIfNonExistantLoginName(java.lang.String pLoginName)
public Authenticator getAuthenticator()
public void setAuthenticator(Authenticator pAuthenticator)
public void setPathAuthenticatorMap(ServiceMap pMap)
public ServiceMap getPathAuthenticatorMap()
public boolean getEnabled()
public void setEnabled(boolean pEnabled)
public boolean getLogSuccessfulAuthentications()
Default is false.
public void setLogSuccessfulAuthentications(boolean pDoLog)
public boolean getLogFailedAuthentications()
Default is true.
public void setLogFailedAuthentications(boolean pDoLog)
public java.lang.String getUnauthorizedMessage()
public void setUnauthorizedMessage(java.lang.String pUnauthorizedMessage)
public void doStartService() throws ServiceException
doStartService
in class GenericService
ServiceException
- if the Service had a problem starting uppublic void service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
service
in class PipelineableServletImpl
javax.servlet.ServletException
- if an error occurred while processing
the servlet request
java.io.IOException
- if an error occurred while reading or writing
the servlet request
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |