Add cache file type to path resolver
[shibboleth/cpp-xmltooling.git] / xmltooling / util / PathResolver.h
index a19cc89..3bfb07e 100644 (file)
@@ -1,17 +1,21 @@
-/*
- *  Copyright 2001-2010 Internet2
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
  *
- * 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
+ * UCAID 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
+ * 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.
+ * 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.
  */
 
 /**
@@ -44,7 +48,8 @@ namespace xmltooling {
             XMLTOOLING_LOG_FILE,
             XMLTOOLING_XML_FILE,
             XMLTOOLING_RUN_FILE,
-            XMLTOOLING_CFG_FILE
+            XMLTOOLING_CFG_FILE,
+            XMLTOOLING_CACHE_FILE
         };
 
         /**
@@ -102,6 +107,14 @@ namespace xmltooling {
         virtual void setCfgDir(const char* dir);
 
         /**
+         * Set the cache directory to use when resolving files.
+         * <p>If relative, the default prefix will be prepended.
+         *
+         * @param dir    the cache directory to use
+         */
+        virtual void setCacheDir(const char* dir);
+
+        /**
          * Changes the input filename into an absolute pathname to the same file.
          *
          * @param s         filename to resolve
@@ -116,7 +129,7 @@ namespace xmltooling {
     private:
         bool isAbsolute(const char* s) const;
 
-        std::string m_defaultPackage,m_defaultPrefix,m_lib,m_log,m_xml,m_run,m_cfg;
+        std::string m_defaultPackage,m_defaultPrefix,m_lib,m_log,m_xml,m_run,m_cfg,m_cache;
     };
 };