php/src/common/SecurityToken.php

   1 <?php
   2 /**
   3  * Licensed to the Apache Software Foundation (ASF) under one
   4  * or more contributor license agreements.  See the NOTICE file
   5  * distributed with this work for additional information
   6  * regarding copyright ownership.  The ASF licenses this file
   7  * to you under the Apache License, Version 2.0 (the
   8  * "License"); you may not use this file except in compliance
   9  * with the License.  You may obtain a copy of the License at
  10  *
  11  *     http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing,
  14  * software distributed under the License is distributed on an
  15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  16  * KIND, either express or implied.  See the License for the
  17  * specific language governing permissions and limitations
  18  * under the License.
  19  */
  20
  21
  22 /**
  23  * An abstract representation of a signing token.
  24  * Use in conjunction with @code SecurityTokenDecoder.
  25  */
  26 abstract class SecurityToken {
  27
  28   static public function createFromToken($token, $maxage) {}
  29
  30   static public function createFromValues($owner, $viewer, $app, $domain, $appUrl, $moduleId, $containerId) {}
  31
  32   /**
  33    * is this an anonymous token? Always check this before using the owner/viewer/etc
  34    *
  35    * @return boolean if it's anonymous
  36    */
  37   abstract public function isAnonymous();
  38
  39   /**
  40    * Serializes the token into a string. This can be the exact same as
  41    * toString; using a different name here is only to force interface
  42    * compliance.
  43    *
  44    * @return A string representation of the token.
  45    */
  46   abstract public function toSerialForm();
  47
  48   /**
  49    * @return the owner from the token, or null if there is none.
  50    */
  51   abstract public function getOwnerId();
  52
  53   /**
  54    * @return the viewer from the token, or null if there is none.
  55    */
  56   abstract public function getViewerId();
  57
  58   /**
  59    * @return the application id from the token, or null if there is none.
  60    */
  61   abstract public function getAppId();
  62
  63   /**
  64    * @return the domain from the token, or null if there is none.
  65    */
  66   abstract public function getDomain();
  67
  68   /**
  69    * @return the URL of the application
  70    */
  71   abstract public function getAppUrl();
  72
  73   /**
  74    * @return the module ID of the application
  75    */
  76   abstract public function getModuleId();
  77
  78   /**
  79    * @return string
  80    */
  81   abstract public function getAuthenticationMode();
  82
  83   abstract public function setAuthenticationMode($mode);
  84 }