libjava/classpath/gnu/javax/sound/AudioSecurityManager.java

   1 /* AudioSecurityManager.java -- Manages Security requests for Sound classes.
   2
   3  Copyright (C) 2007 Free Software Foundation, Inc.
   4
   5 This file is part of GNU Classpath.
   6
   7 GNU Classpath is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2, or (at your option)
  10 any later version.
  11
  12 GNU Classpath is distributed in the hope that it will be useful, but
  13 WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU Classpath; see the file COPYING.  If not, write to the
  19 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  20 02110-1301 USA.
  21
  22 Linking this library statically or dynamically with other modules is
  23 making a combined work based on this library.  Thus, the terms and
  24 conditions of the GNU General Public License cover the whole
  25 combination.
  26
  27 As a special exception, the copyright holders of this library give you
  28 permission to link this library with independent modules to produce an
  29 executable, regardless of the license terms of these independent
  30 modules, and to copy and distribute the resulting executable under
  31 terms of your choice, provided that you also meet, for each linked
  32 independent module, the terms and conditions of the license of that
  33 module.  An independent module is a module which is not derived from
  34 or based on this library.  If you modify this library, you may extend
  35 this exception to your version of the library, but you are not
  36 obligated to do so.  If you do not wish to do so, delete this
  37 exception statement from your version. */
  38
  39 package gnu.javax.sound;
  40
  41 import javax.sound.sampled.AudioPermission;
  42
  43 /**
  44  * This class handles security requests for classes in the Sound API.
  45  *
  46  * A class that needs to check against a particular permission type may use this
  47  * class to query the <code>SecurityManager</code>.
  48  *
  49  * For example, to check for a read permission, a class can simply pass the
  50  * <code>Permission.READ</code> constant to
  51  * {@link #checkPermissions(gnu.javax.sound.AudioSecurityManager.Permission))},
  52  * like the following code demonstrates:
  53  *
  54  * <pre>
  55  * AudioSecurityManager.checkPermissions(Permission.PLAY);
  56  * </pre>
  57  *
  58  * If there is need to query for all the defined permissions type, the constant
  59  * <code>Permission.ALL</code> can be used. In alternative, the
  60  * {@link #checkPermissions()} is presented as a shorthand.
  61  *
  62  * @author Mario Torre <neugens@limasoftware.net>
  63  */
  64 public class AudioSecurityManager
  65 {
  66   /**
  67    * Defines a common set of permission allowed by the specification.
  68    */
  69   public static enum Permission
  70   {
  71     PLAY, RECORD, ALL
  72   }
  73
  74   /**
  75    * Shorthand to <code>checkPermissions(Permission.ALL)</code>.
  76    */
  77   public static final void checkPermissions()
  78   {
  79     checkPermissions(Permission.ALL);
  80   }
  81
  82   /**
  83    * Query the <code>SecurityManager</code> agains the given
  84    * <code>Permission</code>.
  85    *
  86    * @param permission
  87    */
  88   public static final void checkPermissions(Permission permission)
  89   {
  90     SecurityManager sm = System.getSecurityManager();
  91     if (sm != null)
  92       {
  93         String perm = null;
  94         switch (permission)
  95           {
  96           case PLAY:
  97             perm = "play";
  98             break;
  99
 100           case RECORD:
 101             perm = "record";
 102             break;
 103
 104           case ALL: default:
 105             perm = "*";
 106             break;
 107           }
 108
 109         sm.checkPermission(new AudioPermission(perm));
 110       }
 111   }
 112 }