org.kitei.testing.lessio.AllowLocalFileAccess Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kitei-lessio Show documentation
The newest version!
/*
 * Licensed 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.kitei.testing.lessio;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Under the regime of {@link LessIOSecurityManager}, only classes annotated
 * with this annotation may perform IO on local files. Such annotated classes
 * will only be allowed to access the paths specified in {@link #paths()}.
 *
 * The following values are recognized for {@link #paths()}:
 * 
 * %TMP_DIR%, allows IO to anything inside the JVM's temporary directory, as
 * per the java.io.tmpdir system property as retrieved via
 * {@link System#getProperty(String)}
 * %FD%, allows IO via any file descriptor
 * *, allows IO to any file or directory (path)
 * *[part]*, allows IO to any path which contains [part]
 * *[part], allows IO to any path which ends with [part]
 * [part]*, allows IO to any path which starts with [part]
 * all other values, allow IO to any path which exactly matches the value
 * 
 *
 * Note that due to performance restrictions, the {@link LessIOSecurityManager}
 * only performs textual matches, and does not recognize symbolic links or hard
 * links.
 *
 * @see LessIO Wiki, @AllowLocalFileAccess.
 */
@Retention(RUNTIME)
@Target(TYPE)
public @interface AllowLocalFileAccess
{
    String[] paths();
}