Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License.  You may obtain a copy of the License at
   * 
   *      http://www.apache.org/licenses/LICENSE-2.0
  * 
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
 
 package org.apache.catalina.deploy;
 
 
 
Representation of a web resource collection for a web application's security constraint, as represented in a <web-resource-collection> element in the deployment descriptor.

WARNING: It is assumed that instances of this class will be created and modified only within the context of a single thread, before the instance is made visible to the remainder of the application. After that, only read access is expected. Therefore, none of the read and write access within this class is synchronized.

Author(s):
Craig R. McClanahan
Version:
$Revision: 1237 $ $Date: 2009-11-03 02:55:48 +0100 (Tue, 03 Nov 2009) $
 
 
 public class SecurityCollection implements Serializable {
 
 
     // ----------------------------------------------------------- Constructors
 

    
Construct a new security collection instance with default values.
 
     public SecurityCollection() {
 
         this(nullnull);
 
     }


    
Construct a new security collection instance with specified values.

Parameters:
name Name of this security collection
 
     public SecurityCollection(String name) {
 
         this(namenull);
 
     }


    
Construct a new security collection instance with specified values.

Parameters:
name Name of this security collection
description Description of this security collection
 
     public SecurityCollection(String nameString description) {
 
         super();
         setName(name);
         setDescription(description);
 
     }
 
 
     // ----------------------------------------------------- Instance Variables
 

    
Description of this web resource collection.
 
     private String description = null;


    
The HTTP methods covered by this web resource collection.
 
     private String methods[] = new String[0];


    
The HTTP methods not covered by this web resource collection.
    private String methodOmissions[] = new String[0];


    
The name of this web resource collection.
    private String name = null;


    
The URL patterns protected by this security collection.
    private String patterns[] = new String[0];
    // ------------------------------------------------------------- Properties


    
Return the description of this web resource collection.
    public String getDescription() {
        return (this.);
    }


    
Set the description of this web resource collection.

Parameters:
description The new description
    public void setDescription(String description) {
        this. = description;
    }


    
Return the name of this web resource collection.
    public String getName() {
        return (this.);
    }


    
Set the name of this web resource collection

Parameters:
name The new name
    public void setName(String name) {
        this. = name;
    }
    // --------------------------------------------------------- Public Methods


    
Add an HTTP request method to be part of this web resource collection.
    public void addMethod(String method) {
        if (method == null)
            return;
        String results[] = new String[. + 1];
        for (int i = 0; i < .i++)
            results[i] = [i];
        results[.] = method;
         = results;
    }


    
Add an HTTP request method to be skipped from this web resource collection.
    public void addMethodOmission(String method) {
        if (method == null)
            return;
        String results[] = new String[. + 1];
        for (int i = 0; i < .i++)
            results[i] = [i];
        results[.] = method;
         = results;
    }


    
Add a URL pattern to be part of this web resource collection.
    public void addPattern(String pattern) {
        if (pattern == null)
            return;
        pattern = RequestUtil.URLDecode(pattern);
        String results[] = new String[. + 1];
        for (int i = 0; i < .i++) {
            results[i] = [i];
        }
        results[.] = pattern;
         = results;
    }


    
Return true if the specified HTTP request method is part of this web resource collection.

Parameters:
method Request method to check
    public boolean findMethod(String method) {
        if (. == 0)
            return (true);
        for (int i = 0; i < .i++) {
            if ([i].equals(method))
                return (true);
        }
        return (false);
    }


    
Return the set of HTTP request methods that are part of this web resource collection, or a zero-length array if all request methods are included.
    public String[] findMethods() {
        return ();
    }


    
Return true if the specified HTTP request method is not part of this web resource collection.

Parameters:
method Request method to check
    public boolean findMethodOmission(String method) {
        for (int i = 0; i < .i++) {
            if ([i].equals(method))
                return (true);
        }
        return (false);
    }


    
Return the set of HTTP request methods that are not part of this web resource collection, or a zero-length array if no request methods is omitted.
    public String[] findMethodOmissions() {
        return ();
    }


    
Is the specified pattern part of this web resource collection?

Parameters:
pattern Pattern to be compared
    public boolean findPattern(String pattern) {
        for (int i = 0; i < .i++) {
            if ([i].equals(pattern))
                return (true);
        }
        return (false);
    }


    
Return the set of URL patterns that are part of this web resource collection. If none have been specified, a zero-length array is returned.
    public String[] findPatterns() {
        return ();
    }


    
Remove the specified HTTP request method from those that are part of this web resource collection.

Parameters:
method Request method to be removed
    public void removeMethod(String method) {
        if (method == null)
            return;
        int n = -1;
        for (int i = 0; i < .i++) {
            if ([i].equals(method)) {
                n = i;
                break;
            }
        }
        if (n >= 0) {
            int j = 0;
            String results[] = new String[. - 1];
            for (int i = 0; i < .i++) {
                if (i != n)
                    results[j++] = [i];
            }
             = results;
        }
    }


    
Remove the specified HTTP request method from those that are not part of this web resource collection.

Parameters:
method Request method to be removed
    public void removeMethodOmission(String method) {
        if (method == null)
            return;
        int n = -1;
        for (int i = 0; i < .i++) {
            if ([i].equals(method)) {
                n = i;
                break;
            }
        }
        if (n >= 0) {
            int j = 0;
            String results[] = new String[. - 1];
            for (int i = 0; i < .i++) {
                if (i != n)
                    results[j++] = [i];
            }
             = results;
        }
    }


    
Remove the specified URL pattern from those that are part of this web resource collection.

Parameters:
pattern Pattern to be removed
    public void removePattern(String pattern) {
        if (pattern == null)
            return;
        int n = -1;
        for (int i = 0; i < .i++) {
            if ([i].equals(pattern)) {
                n = i;
                break;
            }
        }
        if (n >= 0) {
            int j = 0;
            String results[] = new String[. - 1];
            for (int i = 0; i < .i++) {
                if (i != n)
                    results[j++] = [i];
            }
             = results;
        }
    }


    
Return a String representation of this security collection.
    public String toString() {
        StringBuilder sb = new StringBuilder("SecurityCollection[");
        sb.append();
        if ( != null) {
            sb.append(", ");
            sb.append();
        }
        sb.append("]");
        return (sb.toString());
    }
New to GrepCode? Check out our FAQ X