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

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017 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  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  21  */
  22 package org.onap.aai.parsers.uri;
  23
  24 import org.onap.aai.exceptions.AAIException;
  25 import org.onap.aai.introspection.Introspector;
  26 import org.onap.aai.serialization.db.EdgeType;
  27
  28 import javax.ws.rs.core.MultivaluedMap;
  29
  30 /**
  31  * The Interface Parsable.
  32  */
  33 public interface Parsable {
  34
  35         /**
  36          *
  37          * @param obj
  38          * @param type
  39          * @param uriKeys
  40          * @throws AAIException
  41          */
  42         public void processObject(Introspector obj, EdgeType type, MultivaluedMap<String, String> uriKeys) throws AAIException;
  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         public void processContainer(Introspector obj, EdgeType type, MultivaluedMap<String, String> uriKeys, boolean isFinalContainer) throws AAIException;
  52
  53         /**
  54          * Process namespace.
  55          *
  56          * @param obj the obj
  57          */
  58         public void processNamespace(Introspector obj);
  59
  60         /**
  61          * Gets the cloud region transform.
  62          *
  63          * @return the cloud region transform
  64          */
  65         public String getCloudRegionTransform();
  66
  67         /**
  68          * Use original loader.
  69          *
  70          * @return true, if successful
  71          */
  72         public boolean useOriginalLoader();
  73 }