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 package org.onap.aai.parsers.uri;
  21
  22 import org.onap.aai.exceptions.AAIException;
  23 import org.onap.aai.introspection.Introspector;
  24 import org.onap.aai.serialization.db.EdgeType;
  25
  26 import javax.ws.rs.core.MultivaluedMap;
  27
  28 /**
  29  * The Interface Parsable.
  30  */
  31 public interface Parsable {
  32
  33         /**
  34          *
  35          * @param obj
  36          * @param type
  37          * @param uriKeys
  38          * @throws AAIException
  39          */
  40         public void processObject(Introspector obj, EdgeType type, MultivaluedMap<String, String> uriKeys) throws AAIException;
  41         /**
  42          * Process container.
  43          *
  44          * @param obj the obj
  45          * @param uriKeys the uri keys
  46          * @param isFinalContainer the is final container
  47          * @throws AAIException the AAI exception
  48          */
  49         public void processContainer(Introspector obj, EdgeType type, MultivaluedMap<String, String> uriKeys, boolean isFinalContainer) throws AAIException;
  50
  51         /**
  52          * Process namespace.
  53          *
  54          * @param obj the obj
  55          */
  56         public void processNamespace(Introspector obj);
  57
  58         /**
  59          * Gets the cloud region transform.
  60          *
  61          * @return the cloud region transform
  62          */
  63         public String getCloudRegionTransform();
  64
  65         /**
  66          * Use original loader.
  67          *
  68          * @return true, if successful
  69          */
  70         public boolean useOriginalLoader();
  71 }