public interface Realm
| Modifier and Type | Method and Description | 
|---|---|
| void | addPropertyChangeListener(PropertyChangeListener listener)Add a property change listener to this component. | 
| Principal | authenticate(GSSContext gssContext,
            boolean storeCreds)Try to authenticate using a  GSSContext | 
| Principal | authenticate(String username)Try to authenticate with the specified username. | 
| Principal | authenticate(String username,
            String credentials)Try to authenticate using the specified username and
 credentials. | 
| Principal | authenticate(String username,
            String digest,
            String nonce,
            String nc,
            String cnonce,
            String qop,
            String realm,
            String md5a2)Try to authenticate with the specified username, which
 matches the digest calculated using the given parameters using the
 method described in RFC 2617 (which is a superset of RFC 2069). | 
| Principal | authenticate(X509Certificate[] certs)Try to authenticate using  X509Certificates | 
| void | backgroundProcess()Execute a periodic task, such as reloading, etc. | 
| SecurityConstraint[] | findSecurityConstraints(Request request,
                       Context context)Find the SecurityConstraints configured to guard the request URI for
 this request. | 
| Container | getContainer() | 
| String | getInfo() | 
| boolean | hasResourcePermission(Request request,
                     Response response,
                     SecurityConstraint[] constraint,
                     Context context)Perform access control based on the specified authorization constraint. | 
| boolean | hasRole(Wrapper wrapper,
       Principal principal,
       String role)Check if the specified Principal has the specified
 security role, within the context of this Realm. | 
| boolean | hasUserDataPermission(Request request,
                     Response response,
                     SecurityConstraint[] constraint)Enforce any user data constraint required by the security constraint
 guarding this request URI. | 
| void | removePropertyChangeListener(PropertyChangeListener listener)Remove a property change listener from this component. | 
| void | setContainer(Container container)Set the Container with which this Realm has been associated. | 
Container getContainer()
void setContainer(Container container)
container - The associated ContainerString getInfo()
<description>/<version>.void addPropertyChangeListener(PropertyChangeListener listener)
listener - The listener to addPrincipal authenticate(String username)
username - Username of the Principal to look upnull if none is
         associated.Principal authenticate(String username, String credentials)
username - Username of the Principal to look upcredentials - Password or other credentials to use in
 authenticating this usernamenull if there is nonePrincipal authenticate(String username, String digest, String nonce, String nc, String cnonce, String qop, String realm, String md5a2)
username - Username of the Principal to look updigest - Digest which has been submitted by the clientnonce - Unique (or supposedly unique) token which has been used
 for this requestnc - the nonce countercnonce - the client chosen nonceqop - the "quality of protection" (nc and cnonce
        will only be used, if qop is not null).realm - Realm namemd5a2 - Second MD5 digest used to calculate the digest :
 MD5(Method + ":" + uri)null if there is none.Principal authenticate(GSSContext gssContext, boolean storeCreds)
GSSContextgssContext - The gssContext processed by the Authenticator.storeCreds - Should the realm attempt to store the delegated
                   credentials in the returned Principal?null if there is nonePrincipal authenticate(X509Certificate[] certs)
X509Certificatescerts - Array of client certificates, with the first one in
  the array being the certificate of the client itself.null if there is nonevoid backgroundProcess()
SecurityConstraint[] findSecurityConstraints(Request request, Context context)
request - Request we are processingcontext - Context for this requestSecurityConstraint, of null
         if there is noneboolean hasResourcePermission(Request request, Response response, SecurityConstraint[] constraint, Context context) throws IOException
request - Request we are processingresponse - Response we are creatingconstraint - Security constraint we are enforcingcontext - The Context to which client of this class is attached.true if this constraint is satisfied and processing
         should continue, or false otherwiseIOException - if an input/output error occursboolean hasRole(Wrapper wrapper, Principal principal, String role)
wrapper - wrapper context for evaluating roleprincipal - Principal for whom the role is to be checkedrole - Security role to be checkedtrue if the specified Principal has the specified
         security role, within the context of this Realm; otherwise return
         false.boolean hasUserDataPermission(Request request, Response response, SecurityConstraint[] constraint) throws IOException
request - Request we are processingresponse - Response we are creatingconstraint - Security constraint being checkedtrue if this constraint
         was not violated and processing should continue, or false
         if we have created a response already.IOException - if an input/output error occursvoid removePropertyChangeListener(PropertyChangeListener listener)
listener - The listener to removeCopyright © 2000-2020 Apache Software Foundation. All Rights Reserved.