RestResource.java

/*
** Module   : RestResource.java
** Abstract : Defined a REST resource, from the resourceModel.xml file.
**
** Copyright (c) 2019-2020, Golden Code Development Corporation.
**
** -#- -I- --Date-- --------------------------------------Description---------------------------------------
** 001 CA  20190614 First version.
** 002 GES 20200723 Added the address member.
*/

/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program 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 may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
** 
** Additional terms under GNU Affero GPL version 3 section 7:
** 
**   Under Section 7 of the GNU Affero GPL version 3, the following additional
**   terms apply to the works covered under the License.  These additional terms
**   are non-permissive additional terms allowed under Section 7 of the GNU
**   Affero GPL version 3 and may not be removed by you.
** 
**   0. Attribution Requirement.
** 
**     You must preserve all legal notices or author attributions in the covered
**     work or Appropriate Legal Notices displayed by works containing the covered
**     work.  You may not remove from the covered work any author or developer
**     credit already included within the covered work.
** 
**   1. No License To Use Trademarks.
** 
**     This license does not grant any license or rights to use the trademarks
**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
**     of Golden Code Development Corporation. You are not authorized to use the
**     name Golden Code, FWD, or the names of any author or contributor, for
**     publicity purposes without written authorization.
** 
**   2. No Misrepresentation of Affiliation.
** 
**     You may not represent yourself as Golden Code Development Corporation or FWD.
** 
**     You may not represent yourself for publicity purposes as associated with
**     Golden Code Development Corporation, FWD, or any author or contributor to
**     the covered work, without written authorization.
** 
**   3. No Misrepresentation of Source or Origin.
** 
**     You may not represent the covered work as solely your work.  All modified
**     versions of the covered work must be marked in a reasonable way to make it
**     clear that the modified work is not originating from Golden Code Development
**     Corporation or FWD.  All modified versions must contain the notices of
**     attribution required in this license.
*/

package com.goldencode.p2j.pattern;

import java.util.*;

/**
 * Class identifying a REST resource from <code>resourceModel.xml</code>.
 */
class RestResource
{
   /** resourceModel.xml prgs:resource[name] */
   final String name;
   
   /** resourceModel.xml prgs:resource[path] */
   final String path;
   
   /** Service-level path suffix, may be {@code null} or empty string.  Defined in spring.xml. */
   final String address;

   /** resourceModel.xml prgs:resource[consumes] */
   private final String consumes;
   
   /** resourceModel.xml prgs:resource[produces] */
   private final String produces;
   
   /** resourceModel.xml prgs:resource/prgs:operation*/
   final Map<String, RestOperation> operations = new HashMap<>();
   
   /**
    * Constructor.
    *
    * @param    name
    *           Resource name.
    * @param    path
    *           Resource path.
    * @param    address
    *           Service-specific path suffix.
    * @param    consumes
    *           MIME type consumed.
    * @param    produces
    *           MIME type produced.
    */
   public RestResource(String name, String path, String address, String consumes, String produces)
   {
      this.name     = name;
      this.path     = path;
      this.address  = address;
      this.consumes = consumes;
      this.produces = produces;
   }
}