Change license header, remove stale pkg files.

[shibboleth/cpp-opensaml.git] / saml / saml2 / metadata / AbstractMetadataProvider.h

diff --git a/saml/saml2/metadata/AbstractMetadataProvider.h b/saml/saml2/metadata/AbstractMetadataProvider.h
index 3bccb93..9670e57 100644 (file)
--- a/saml/saml2/metadata/AbstractMetadataProvider.h
+++ b/saml/saml2/metadata/AbstractMetadataProvider.h
@@ -1,17 +1,21 @@
-/*
- *  Copyright 2001-2010 Internet2
- * 
- * 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
+/**
+ * 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.
+ *
+ * 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.
  */
 
 /**
@@ -90,8 +94,29 @@ namespace opensaml {
             xmltooling::KeyInfoResolver* m_resolver;
 
             /**
-             * Loads an entity into the cache for faster lookup. This includes
-             * processing known reverse lookup strategies for artifacts.
+             * Loads an entity into the cache for faster lookup.
+             * <p>This includes processing known reverse lookup strategies for artifacts.
+             * The validUntil parameter will contain the smallest value found on output.
+             * 
+             * @param site          entity definition
+             * @param validUntil    maximum expiration time of the entity definition
+             * @param replace       true iff existing entries for the same entity should be cleared/replaced
+             */
+            virtual void indexEntity(EntityDescriptor* site, time_t& validUntil, bool replace=false) const;
+
+            /**
+             * Loads a group of entities into the cache for faster lookup.
+             * <p>The validUntil parameter will contain the smallest value found on output.
+             * 
+             * @param group         group definition
+             * @param validUntil    maximum expiration time of the group definition
+             */
+            virtual void indexGroup(EntitiesDescriptor* group, time_t& validUntil) const;
+
+            /**
+             * @deprecated
+             * Loads an entity into the cache for faster lookup.
+             * <p>This includes processing known reverse lookup strategies for artifacts.
              * 
              * @param site          entity definition
              * @param validUntil    maximum expiration time of the entity definition
@@ -100,13 +125,14 @@ namespace opensaml {
             virtual void index(EntityDescriptor* site, time_t validUntil, bool replace=false) const;
 
             /**
+             * @deprecated
              * Loads a group of entities into the cache for faster lookup.
              * 
              * @param group         group definition
              * @param validUntil    maximum expiration time of the group definition
              */
             virtual void index(EntitiesDescriptor* group, time_t validUntil) const;
-        
+
             /**
              * Clear the cache of known entities and groups.
              *