https://issues.shibboleth.net/jira/browse/SSPCPP-349

[shibboleth/cpp-sp.git] / shibsp / handler / SessionInitiator.h

diff --git a/shibsp/handler/SessionInitiator.h b/shibsp/handler/SessionInitiator.h
index f64fe18..3643aef 100644 (file)
--- a/shibsp/handler/SessionInitiator.h
+++ b/shibsp/handler/SessionInitiator.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.
  */
 
 /**
@@ -31,6 +35,8 @@
 
 namespace shibsp {
 
+    class SHIBSP_API AuthnRequestEvent;
+
     /**
      * Pluggable runtime functionality that handles initiating sessions.
      *
@@ -61,6 +67,19 @@ namespace shibsp {
          */
         bool checkCompatibility(SPRequest& request, bool isHandler) const;
 
+#ifndef SHIBSP_LITE
+        /**
+         * Creates a new AuthnRequestEvent for the event log.
+         *
+         * @param application   the Application associated with the event
+         * @param request       the HTTP client request associated with the event, or nullptr
+         * @return  a fresh AuthnRequestEvent, prepopulated by the input parameters, or nullptr if an error occurs
+         */
+        virtual AuthnRequestEvent* newAuthnRequestEvent(
+            const Application& application, const xmltooling::HTTPRequest* request=nullptr
+            ) const;
+#endif
+
     public:
         virtual ~SessionInitiator();