Class Overview
Title: DefaultExternalSecurity.
Description: This is Web Universal's default implementation of the ExternalSecurity interface.
Summary
[Expand]
Inherited Constants |
From interface
com.microstrategy.web.app.ExternalSecurity
int |
AUTHENTICATION_REQUEST |
Indicates the request type was for authentication |
int |
AUTHORIZATION_REQUEST |
Indicates the request type was for authorization |
int |
COLLECT_SESSION_NOW |
Value that the handlesAuthenticationRequest() method might return if the session should be handled by
ExternalSecurity methods |
int |
INVALID_CREDENTIALS |
Reason why the handlesAuthenticationRequest() should be called: the session that was aviailable for use has wrong credential information |
int |
LOGIN_FIRST |
Reason why the handlesAuthenticationRequest() should be called: There is no login first session or the login first session is invalid. |
int |
MISMATCHED_PREFERENCES |
Reason why the Web ask for reconnect session. |
int |
NO_SESSION_FOUND |
Reason why the handlesAuthenticationRequest() should be called: there was no session available for the application to use |
int |
SESSION_CLOSED |
Reason why the handlesAuthenticationRequest() should be called: the session that was available for use has expired |
int |
USE_CUSTOM_LOGIN_PAGE |
Value that the handlesAuthenticationRequest() method might return if the session should be prepared first
by a custom login page specified by the ExternalSecurity component |
int |
USE_MSTR_DEFAULT_LOGIN |
Value that the handlesAuthenticationRequest() method might return if the session should be handled
by Web Universal |
|
[Expand]
Inherited Methods |
From class
com.microstrategy.web.app.AbstractExternalSecurity
boolean
|
canReconnectSession(ContainerServices cntSvcs, WebIServerSession currentSession, int reason)
This method will be called each time Microstrategy Web tries to automatically reconnect
a session that is still valid.
|
boolean
|
closeSessionOnLogout(RequestKeys reqKeys, ContainerServices cntSvcs, WebIServerSession user)
Method to be called when the user or system invokes a logout event.
|
WebAppSessionManager
|
getAppSessionManager()
Get the web web app session manager.
|
String
|
getCustomLoginURL(String originalURL, String desiredServer, int desiredPort, String desiredProject)
Returns the URL of a custom page that will handle the authentication request, in case the handlesAuthenticationRequest() method
returned USE_CUSTOM_LOGIN_PAGE
|
String
|
getFailureURL(int reqType, ContainerServices cntrSvcs)
Once it has been determined the request has failed, this method will provide the URL information where the user
should be taken next.
|
int
|
getPort(RequestKeys reqKeys)
Returns the Port from RequestKeys
|
String
|
getProject(RequestKeys reqKeys)
Returns the Project Name from RequestKeys
|
String
|
getServer(RequestKeys reqKeys)
Returns the Server Name from RequestKeys.
|
WebIServerSession
|
getWebIServerSession(RequestKeys reqKeys, ContainerServices cntSvcs)
Create a new session object based on the information provided.
|
AbstractWebLoginProvider
|
getWebLoginProvider(int webLoginMode)
Get the web login provider for a particular web login mode.
|
int
|
handlesAuthenticationRequest(RequestKeys reqKeys, ContainerServices cntSvcs, int reason)
Indicates how ExternalSecurity wants to handle the session (authentication) request
|
boolean
|
isRequestAuthorized(RequestKeys reqKeys, ContainerServices cntSvcs, WebIServerSession user)
Determines if the user is authorized to perform the incoming request
|
boolean
|
processMSTRLoginForm(RequestKeys reqKeys, ContainerServices cntrSvcs, LoginForm loginForm, int reason)
Manipulates the already created WebIServerSession instance and modifies it if required
|
void
|
setAppSessionManager(WebAppSessionManager appSessionManager)
Set the web web app session manager.
|
|
From class
java.lang.Object
Object
|
clone()
|
boolean
|
equals(Object arg0)
|
void
|
finalize()
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
final
void
|
wait()
|
|
From interface
com.microstrategy.web.app.ExternalSecurity
abstract
boolean
|
canReconnectSession(ContainerServices cntSvcs, WebIServerSession currentSession, int reason)
This method will be called each time Microstrategy Web tries to automatically reconnect
a session that is still valid.
|
abstract
boolean
|
closeSessionOnLogout(RequestKeys reqKeys, ContainerServices cntSvcs, WebIServerSession user)
Method to be called when the user or system invokes a logout event.
|
abstract
String
|
getCustomLoginURL(String originalURL, String desiredServer, int desiredPort, String desiredProject)
Returns the URL of a custom page that will handle the authentication request, in case the handlesAuthenticationRequest() method
returned USE_CUSTOM_LOGIN_PAGE
|
abstract
String
|
getFailureURL(int reqType, ContainerServices cntrSvcs)
Once it has been determined the request has failed, this method will provide the URL information where the user
should be taken next.
|
abstract
WebIServerSession
|
getWebIServerSession(RequestKeys reqKeys, ContainerServices cntSvcs)
Create a new session object based on the information provided.
|
abstract
int
|
handlesAuthenticationRequest(RequestKeys reqKeys, ContainerServices cntSvcs, int reason)
Indicates how ExternalSecurity wants to handle the session (authentication) request
|
abstract
boolean
|
isRequestAuthorized(RequestKeys reqKeys, ContainerServices cntSvcs, WebIServerSession user)
Determines if the user is authorized to perform the incoming request
|
abstract
boolean
|
processMSTRLoginForm(RequestKeys reqKeys, ContainerServices cntrSvcs, LoginForm loginForm, int reason)
Manipulates the already created WebIServerSession instance and modifies it if required
|
|
Public Constructors
public
DefaultExternalSecurity
()