<?php
  /**
   * ownCloud - Apache backend
   *
   * @author Karl Beecher
   * @copyright 2013 Karl Beecher - karl@endocode.com
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
   * License as published by the Free Software Foundation; either
   * version 3 of the License, or any later version.
   *
   * This library is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
   *
   * You should have received a copy of the GNU Affero General Public
   * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
   *
   */
  
  /**
   * Public interface of ownCloud for apps to use.
   * Authentication/IApacheBackend interface
   */
  
  // use OCP namespace for all classes that are considered public.
  // This means that they should be used by apps instead of the internal ownCloud classes
  namespace OCP\Authentication;
  
  interface IApacheBackend {
  
  	/**
  	 * In case the user has been authenticated by Apache true is returned.
  	 *
  	 * @return boolean whether Apache reports a user as currently logged in.
  	 */
  	public function isSessionActive();
  
  	/**
  	 * Creates an attribute which is added to the logout hyperlink. It can
  	 * supply any attribute(s) which are valid for <a>.
  	 *
  	 * @return string with one or more HTML attributes.
  	 */
  	public function getLogoutAttribute();
  
  	/**
  	 * Return the id of the current user
  	 * @return string
  	 */
  	public function getCurrentUserId();
  
  }