aai-core/src/main/java/org/onap/aai/parsers/uri/Parsable.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * 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, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.aai.parsers.uri;
  22
  23 import javax.ws.rs.core.MultivaluedMap;
  24
  25 import org.onap.aai.edges.enums.EdgeType;
  26 import org.onap.aai.exceptions.AAIException;
  27 import org.onap.aai.introspection.Introspector;
  28
  29 /**
  30  * The Interface Parsable.
  31  */
  32 public interface Parsable {
  33
  34     /**
  35      *
  36      * @param obj
  37      * @param type
  38      * @param uriKeys
  39      * @throws AAIException
  40      */
  41     void processObject(Introspector obj, EdgeType type, MultivaluedMap<String, String> uriKeys) throws AAIException;
  42
  43     /**
  44      * Process container.
  45      *
  46      * @param obj the obj
  47      * @param uriKeys the uri keys
  48      * @param isFinalContainer the is final container
  49      * @throws AAIException the AAI exception
  50      */
  51     void processContainer(Introspector obj, EdgeType type, MultivaluedMap<String, String> uriKeys,
  52             boolean isFinalContainer) throws AAIException;
  53
  54     /**
  55      * Process namespace.
  56      *
  57      * @param obj the obj
  58      */
  59     void processNamespace(Introspector obj);
  60
  61     /**
  62      * Gets the cloud region transform.
  63      *
  64      * @return the cloud region transform
  65      */
  66     String getCloudRegionTransform();
  67
  68     /**
  69      * Use original loader.
  70      *
  71      * @return true, if successful
  72      */
  73     boolean useOriginalLoader();
  74 }