wamblee.org Git - utils/blob - security/impl/src/main/java/org/wamblee/security/authorization/OperationRegistry.java

   1 /*
   2  * Copyright 2005-2010 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.wamblee.security.authorization;
  17
  18 /**
  19  * Utility to map between a list of operations and a string based on the names
  20  * of the operations.
  21  *
  22  * @author Erik Brakkee
  23  */
  24 public interface OperationRegistry {
  25     /**
  26      * Gets the supported operations for a given resource class.
  27      *
  28      * @param aResourceClass
  29      *            Resource class.
  30      *
  31      * @return Supported operations for that class.
  32      */
  33     Operation[] getOperations(Class aResourceClass);
  34
  35     /**
  36      * Converts a number of operations to a string.
  37      *
  38      * @param aOperations
  39      *            Operations to convert.
  40      *
  41      * @return String representation of the allowed operations.
  42      */
  43     String encode(Operation[] aOperations);
  44
  45     /**
  46      * Converts an operations string to an array of operations.
  47      *
  48      * @param aResourceClass
  49      *            Resource class.
  50      * @param aOperationsString
  51      *            Operations string as returned by {@link #encode(Operation[])}.
  52      *
  53      * @return Operations array.
  54      */
  55     Operation[] decode(Class aResourceClass, String aOperationsString);
  56
  57     /**
  58      * Converts an operations string to an array of operations.
  59      *
  60      * @param aOperationsString
  61      *            Operations string as returned by {@link #encode(Operation[])}.
  62      *
  63      * @return Operations array.
  64      */
  65     Operation[] decode(String aOperationsString);
  66 }