Find Usages Raw Download HTML Widget
Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions 
1
  /*
2
   * Licensed to the Apache Software Foundation (ASF) under one
3
   * or more contributor license agreements.  See the NOTICE file
4
   * distributed with this work for additional information
5
   * regarding copyright ownership.  The ASF licenses this file
6
   * to you under the Apache License, Version 2.0 (the
7
   * "License"); you may not use this file except in compliance
8
   * with the License.  You may obtain a copy of the License at
9
   *
10
  *   http://www.apache.org/licenses/LICENSE-2.0
11
  *
12
  * Unless required by applicable law or agreed to in writing,
13
  * software distributed under the License is distributed on an
14
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15
  * KIND, either express or implied.  See the License for the
16
  * specific language governing permissions and limitations
17
  * under the License.
18
  */
19
 package org.apache.sling.api.resource;


The ResourceUtil class provides helper methods dealing with resources. 
25
 
26
 public class ResourceUtil {

    
Resolves relative path segments '.' and '..' in the absolute path. Returns null if not possible (.. points above root) or if path is not absolute. 
32
 
33
     public static String normalize(String path) {
34
 
35
         // don't care for empty paths
36
         if (path.length() == 0) {
37
             return path;
38
         }
39
 
40
         // prepare the path buffer with trailing slash (simplifies impl)
41
         int absOffset = (path.charAt(0) == '/') ? 0 : 1;
42
         char[] buf = new char[path.length() + 1 + absOffset];
43
         if (absOffset == 1) {
44
             buf[0] = '/';
45
         }
46
         path.getChars(0, path.length(), buf, absOffset);
47
         buf[buf.length - 1] = '/';
48
 
49
         int lastSlash = 0; // last slash in path
50
         int numDots = 0; // number of consecutive dots after last slash
51
 
52
         int bufPos = 0;
53
         for (int bufIdx = lastSlash; bufIdx < buf.length; bufIdx++) {
54
             char c = buf[bufIdx];
55
             if (c == '/') {
56
                 if (numDots == 2) {
57
                     if (bufPos == 0) {
58
                         return null;
59
                     }
60
 
61
                     do {
62
                         bufPos--;
63
                     } while (bufPos > 0 && buf[bufPos] != '/');
64
                 }
65
 
66
                 lastSlash = bufIdx;
67
                 numDots = 0;
68
             } else if (c == '.' && numDots < 2) {
69
                 numDots++;
70
             } else {
71
                 // find the next slash
72
                 int nextSlash = bufIdx + 1;
73
                 while (nextSlash < buf.length && buf[nextSlash] != '/') {
74
                     nextSlash++;
75
                 }
76
 
77
                 // append up to the next slash (or end of path)
78
                 if (bufPos < lastSlash) {
79
                     int segLen = nextSlash - bufIdx + 1;
80
                     System.arraycopy(buf, lastSlash, buf, bufPos, segLen);
81
                     bufPos += segLen;
82
                 } else {
83
                     bufPos = nextSlash;
84
                 }
85
 
86
                 numDots = 0;
87
                 lastSlash = nextSlash;
88
                 bufIdx = nextSlash;
89
             }
90
         }
91
 
92
         String resolved;
93
         if (bufPos == 0 && numDots == 0) {
94
             resolved = (absOffset == 0) ? "/" : "";
95
         } else if ((bufPos - absOffset) == path.length()) {
96
             resolved = path;
97
         } else {
98
             resolved = new String(buf, absOffset, bufPos - absOffset);
99
         }
101
        return resolved;
102
    }

    
Utility method returns the parent path of the given path, which is normalized by normalize(java.lang.String) before resolving the parent.

Parameters:
path The path whose parent is to be returned.
Returns:
null if path is the root path (/) or if path is a single name containing no slash (/) characters.
Throws:
java.lang.IllegalArgumentException If the path cannot be normalized by the normalize(java.lang.String) method.
java.lang.NullPointerException If path is null.
117
    public static String getParent(String path) {
118
        if ("/".equals(path)) {
119
            return null;
120
        }
122
        // normalize path (remove . and ..)
123
        path = normalize(path);
125
        // if normalized to root, there is no parent
126
        if (path == null || "/".equals(path)) {
127
            return null;
128
        }
130
        // find the last slash, after which to cut off
131
        int lastSlash = path.lastIndexOf('/');
132
        if (lastSlash < 0) {
133
            // no slash in the path
134
            return null;
135
        } else if (lastSlash == 0) {
136
            // parent is root
137
            return "/";
138
        }
140
        return path.substring(0, lastSlash);
141
    }

    
Utility method returns the parent resource of the resource.

Returns:
The parent resource or null if the rsrc is the root.
Throws:
java.lang.NullPointerException If rsrc is null.
148
    public static Resource getParent(Resource rsrc) {
149
        final String parentPath = getParent(rsrc.getPath());
150
        if ( parentPath == null ) {
151
            return null;
152
        }
153
        return rsrc.getResourceResolver().resolve(parentPath);
154
    }

    
Utility method returns the parent resource of the resource.

Throws:
java.lang.NullPointerException If rsrc is null.
160
    public static String getName(Resource rsrc) {
161
        final String name = getName(rsrc.getPath());
162
        return name;
163
    }

    
Utility method returns the name of the given path, which is normalized by normalize(java.lang.String) before resolving the name.

Parameters:
path The path whose name (the last path element) is to be returned.
Returns:
The empty string if path is the root path (/) or if path is a single name containing no slash (/) characters.
Throws:
java.lang.IllegalArgumentException If the path cannot be normalized by the normalize(java.lang.String) method.
java.lang.NullPointerException If path is null.
178
    public static String getName(String path) {
179
        if ("/".equals(path)) {
180
            return "";
181
        }
183
        // normalize path (remove . and ..)
184
        path = normalize(path);
185
        if ("/".equals(path)) {
186
            return "";
187
        }
189
        // find the last slash
190
        return path.substring(path.lastIndexOf('/') + 1);
191
    }

    
Returns true if the resource res is a synthetic resource.

This method checks whether the resource is an instance of the org.apache.sling.resource.SyntheticResource class.

Parameters:
res The Resource to check whether it is a synthetic resource.
Returns:
true if res is a synthetic resource. false is returned if res is null or not an instance of the org.apache.sling.resource.SyntheticResource class.
207
    public static boolean isSyntheticResource(Resource res) {
208
        return res instanceof SyntheticResource;
209
    }

    
Returns true if the resource res is a "star resource". A star resource is a resource returned from the ResourceResolver.resolve(HttpServletRequest) whose path terminates in a /*. Generally such resource result from requests to something like /some/path/* or /some/path/*.html which may be used web applications to uniformly handle resources to be created.

This method checks whether the resource path ends with a /* indicating such a star resource.

Parameters:
res The Resource to check whether it is a star resource.
Returns:
true if res is to be considered a star resource.
Throws:
java.lang.NullPointerException if res is null.
229
    public static boolean isStarResource(Resource res) {
230
        return res.getPath().endsWith("/*");
231
    }

    
Returns true if the resource res is a non-existing resource.

This method checks the resource type of the resource to match the well-known resource type sling:nonexisting of the NonExistingResource class defined in the Sling API.

Parameters:
res The Resource to check whether it is a non-existing resource.
Returns:
true if res is to be considered a non-existing resource.
Throws:
java.lang.NullPointerException if res is null.
247
    public static boolean isNonExistingResource(Resource res) {
249
    }
New to GrepCode? Check out our FAQ X