com.aspectran.core.adapter.ApplicationAdapter Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2024 The Aspectran Project
*
* 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 com.aspectran.core.adapter;
import java.io.File;
import java.io.IOException;
import java.util.Enumeration;
/**
* The Interface ApplicationAdapter.
*
* @since 2011. 3. 13.
*/
public interface ApplicationAdapter {
/**
* Returns the base path that the current application is mapped to.
* @return the base path for this application
*/
String getBasePath();
/**
* Returns the real path of the existing file as a canonical pathname string.
* @param filePath the relative path or classpath of the file to find
* @return the canonical pathname string of the found file
* @throws IOException If there is no file corresponding to the classpath,
* an exception is thrown, and if it is not the classpath, no exception
* is thrown because the {@link File} instance is returned regardless
* of the existence of the file.
*/
String toRealPath(String filePath) throws IOException;
/**
* Returns the real path of an existing file.
* @param filePath the relative path or classpath of the file to find
* @return the real path of the found file
* @throws IOException If there is no file corresponding to the classpath,
* an exception is thrown, and if it is not the classpath, no exception
* is thrown because the {@link File} instance is returned regardless
* of the existence of the file.
*/
File toRealPathAsFile(String filePath) throws IOException;
/**
* Returns the value for an attribute with the given name.
* @param the value type
* @param name the name of the attribute
* @return the value for the attribute
*/
T getAttribute(String name);
/**
* Sets the value for the attribute of the given name,
* replacing an existing value (if any).
* @param name the name of the attribute
* @param value the value for the attribute
*/
void setAttribute(String name, Object value);
/**
* Returns an {@link Enumeration} containing the names
* of the attributes available to this application.
* @return the attribute names
*/
Enumeration getAttributeNames();
/**
* Removes an attribute set with the given name.
* @param name the name of the attribute to be removed
*/
void removeAttribute(String name);
}