//////////////////////////////////////////////////////////////////////////////// /// @brief session handler /// /// @file /// /// DISCLAIMER /// /// Copyright 2004-2012 triagens GmbH, Cologne, Germany /// /// 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. /// /// Copyright holder is triAGENS GmbH, Cologne, Germany /// /// @author Dr. Frank Celler /// @author Martin Schoenert /// @author Copyright 2010-2012, triAGENS GmbH, Cologne, Germany //////////////////////////////////////////////////////////////////////////////// #ifndef TRIAGENS_USER_MANAGER_SESSION_HANDLER_H #define TRIAGENS_USER_MANAGER_SESSION_HANDLER_H 1 #include "Admin/RestBaseHandler.h" namespace triagens { namespace admin { class ApplicationAdminServer; class Session; // ----------------------------------------------------------------------------- // --SECTION-- class SessionHandler // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup RestServer /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief session handler //////////////////////////////////////////////////////////////////////////////// class SessionHandler : public RestBaseHandler { public: //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- static public methods // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup RestServer /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief static constructor //////////////////////////////////////////////////////////////////////////////// static rest::HttpHandler* create (rest::HttpRequest* request, void* data); //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- constructors and destructors // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup RestServer /// @{ //////////////////////////////////////////////////////////////////////////////// protected: //////////////////////////////////////////////////////////////////////////////// /// @brief constructor //////////////////////////////////////////////////////////////////////////////// SessionHandler (rest::HttpRequest* request, ApplicationAdminServer*); //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- Handler methods // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup RestServer /// @{ //////////////////////////////////////////////////////////////////////////////// public: //////////////////////////////////////////////////////////////////////////////// /// {@inheritDoc} //////////////////////////////////////////////////////////////////////////////// bool isDirect (); //////////////////////////////////////////////////////////////////////////////// /// {@inheritDoc} //////////////////////////////////////////////////////////////////////////////// status_e execute (); //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- private methods // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup RestServer /// @{ //////////////////////////////////////////////////////////////////////////////// private: //////////////////////////////////////////////////////////////////////////////// /// @brief creates a session //////////////////////////////////////////////////////////////////////////////// status_e executePost (); //////////////////////////////////////////////////////////////////////////////// /// @brief reads a session //////////////////////////////////////////////////////////////////////////////// status_e executeGet (); //////////////////////////////////////////////////////////////////////////////// /// @brief updates a session //////////////////////////////////////////////////////////////////////////////// status_e executePut (); //////////////////////////////////////////////////////////////////////////////// /// @brief deletes a session //////////////////////////////////////////////////////////////////////////////// status_e executeDelete (); //////////////////////////////////////////////////////////////////////////////// /// @brief logs in an user //////////////////////////////////////////////////////////////////////////////// status_e executeLogin (Session*); //////////////////////////////////////////////////////////////////////////////// /// @brief logs out an user //////////////////////////////////////////////////////////////////////////////// status_e executeLogout (Session*); //////////////////////////////////////////////////////////////////////////////// /// @brief changes the password //////////////////////////////////////////////////////////////////////////////// status_e executePassword (Session*); //////////////////////////////////////////////////////////////////////////////// /// @brief generates a new session //////////////////////////////////////////////////////////////////////////////// void generateSession (Session*); //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- private variables // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup RestServer /// @{ //////////////////////////////////////////////////////////////////////////////// private: //////////////////////////////////////////////////////////////////////////////// /// @brief underlying user manager //////////////////////////////////////////////////////////////////////////////// ApplicationAdminServer* _server; }; } } //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// #endif // Local Variables: // mode: outline-minor // outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @\\}\\)" // End: