Package com.spotfire.server.security
Class AbstractPostAuthenticationFilter
- java.lang.Object
-
- com.spotfire.server.security.AbstractPostAuthenticationFilter
-
- All Implemented Interfaces:
PostAuthenticationFilter
@Deprecated public abstract class AbstractPostAuthenticationFilter extends Object implements PostAuthenticationFilter
Deprecated.This class is deprecated and will be removed in a future release. For things related to configuration usePostAuthenticationFilterInitContext.getParameters()
For things related to attributes useAuthenticationContext
Access to files or resources should be avoidedAn abstract base class for customPostAuthenticationFilter
implementations. The class provides some convenience methods, that are useful when configuring the custom filter.- Since:
- 3.0
- Author:
- Michael Krammer
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractPostAuthenticationFilter()
Deprecated.Creates a new instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Object
getAttribute(String name)
Deprecated.This class is deprecated and will be removed in a future release.Enumeration
getAttributeNames()
Deprecated.This class is deprecated and will be removed in a future release.File
getConfigurationFile(String file)
Deprecated.This class is deprecated and will be removed in a future release.String
getInitParameter(String parameterName)
Deprecated.This class is deprecated and will be removed in a future release.Enumeration
getInitParameterNames()
Deprecated.This class is deprecated and will be removed in a future release.static String
getRealFilePath(String file)
Deprecated.This class is deprecated and will be removed in a future release.URL
getResource(String path)
Deprecated.This class is deprecated and will be removed in a future release.InputStream
getResourceAsStream(String path)
Deprecated.This class is deprecated and will be removed in a future release.String
getWebAppPath()
Deprecated.This class is deprecated and will be removed in a future release.void
removeAttribute(String name)
Deprecated.This class is deprecated and will be removed in a future release.void
setAttribute(String name, Object value)
Deprecated.This class is deprecated and will be removed in a future release.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.spotfire.server.security.PostAuthenticationFilter
filter, init, setConfiguration
-
-
-
-
Method Detail
-
getInitParameter
@Deprecated public String getInitParameter(String parameterName)
Deprecated.This class is deprecated and will be removed in a future release. Please usePostAuthenticationFilterInitContext.getParameters()
instead.Returns the specified initialization parameter from the web application's deployment descriptor. This method works just like theServletContext.getInitParameter(java.lang.String)
method.- Parameters:
parameterName
- the name of the initialization parameter- Returns:
- the value of the initialization parameter
- Since:
- 3.0
-
getInitParameterNames
@Deprecated public Enumeration getInitParameterNames()
Deprecated.This class is deprecated and will be removed in a future release. Please usePostAuthenticationFilterInitContext.getParameters()
instead.Returns the names of the web application's deployment descriptor's initialization parameters as anEnumeration
ofString
objects, or an emptyEnumeration
if the deployment descriptor has no initialization parameters. This method works just like theServletContext.getInitParameterNames()
method.- Returns:
- the initialization parameter names
- Since:
- 3.0
-
getResource
@Deprecated public URL getResource(String path) throws MalformedURLException
Deprecated.This class is deprecated and will be removed in a future release. This method has no replacement.Returns aURL
to the resource that is mapped to a specified path. This method works just like thegetResource(java.lang.String)
method.- Parameters:
path
- the path to the resource- Returns:
- the resource located at the specified path, or
null
if the resource does not exist at that path - Throws:
MalformedURLException
- if the specified path is not given in the correct form- Since:
- 3.0
-
getResourceAsStream
@Deprecated public InputStream getResourceAsStream(String path)
Deprecated.This class is deprecated and will be removed in a future release. This method has no replacement.Returns the resource located at the named path as an InputStream object. This method works just like theServletContext.getResourceAsStream(java.lang.String)
method.- Parameters:
path
- the path to the resource- Returns:
- an
InputStream
for the resource located at the specified path, ornull
if the resource does not exist at that path - Since:
- 3.0
-
getWebAppPath
@Deprecated public String getWebAppPath()
Deprecated.This class is deprecated and will be removed in a future release. This method has no replacement.Returns the web application root's absolute file system path.- Returns:
- the web application root's absolute file system path
- Since:
- 3.0
-
getRealFilePath
@Deprecated public static String getRealFilePath(String file) throws IOException
Deprecated.This class is deprecated and will be removed in a future release. This method has no replacement.Convert the specified file path to an absolute file system path. The argument may either be an absolute path, in which case its canonical path is returned, or a path relative to the web application's root directory, in which case its absolute canonical path is returned. If the specified file exists but isn't a normal file,null
is returned.- Parameters:
file
- a file path, either absolute or relative- Returns:
- an absolute, canonical file path
- Throws:
IOException
- if the conversion of an absolute path to a canonical path fails- Since:
- 3.0
-
getConfigurationFile
@Deprecated public File getConfigurationFile(String file) throws IOException
Deprecated.This class is deprecated and will be removed in a future release. This method has no replacement.The method creates aFile
object for the specified configuration file. The method returnsnull
if the configuration file does not exist. Thefile
parameter must either be an absolute file path or a path relative to the web application's root directory.- Parameters:
file
- the name of the configuration file, either absolute or relative to the web application's root directory- Returns:
- a
File
object if the specified file exists, ornull
if the specified does not exist - Throws:
IOException
- if the conversion of an absolute path to a canonical path fails- Since:
- 3.0
-
getAttribute
@Deprecated public Object getAttribute(String name)
Deprecated.This class is deprecated and will be removed in a future release. Please useAuthenticationContext.getAttribute(String)
instead.Returns the specified attribute from the web application's context, ornull
if there is no attribute by that name. This method works just like theServletContext.getAttribute(java.lang.String)
method.- Parameters:
name
- the attribute name- Returns:
- the attribute value
- Since:
- 3.0
-
getAttributeNames
@Deprecated public Enumeration getAttributeNames()
Deprecated.This class is deprecated and will be removed in a future release. Please useAuthenticationContext.getAttributeNames()
instead.Returns the attribute names from the web application's context as anEnumeration
ofString
objects, or an emptyEnumeration
if there are no attributes. This method works just like theServletContext.getAttributeNames()
method.- Returns:
- the attribute names
- Since:
- 3.0
-
setAttribute
@Deprecated public void setAttribute(String name, Object value)
Deprecated.This class is deprecated and will be removed in a future release. Please useAuthenticationContext.getRequestContext()
instead.Binds an object to a given attribute name in the web application's context. This method works just like theServletContext.setAttribute(java.lang.String,java.lang.Object)
method.- Parameters:
name
- the name of the attribute to be setvalue
- the attribute value- Since:
- 3.0
-
removeAttribute
@Deprecated public void removeAttribute(String name)
Deprecated.This class is deprecated and will be removed in a future release. Please useAuthenticationContext.getRequestContext()
instead.Removes the attribute with the given name from the web application's context. This method works just like theServletContext.removeAttribute(java.lang.String)
method.- Parameters:
name
- the name of the attribute to be removed- Since:
- 3.0
-
-