aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/core/api/src/main/java/org/onosproject/codec/CodecContext.java
diff options
context:
space:
mode:
Diffstat (limited to 'framework/src/onos/core/api/src/main/java/org/onosproject/codec/CodecContext.java')
-rw-r--r--framework/src/onos/core/api/src/main/java/org/onosproject/codec/CodecContext.java50
1 files changed, 50 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/codec/CodecContext.java b/framework/src/onos/core/api/src/main/java/org/onosproject/codec/CodecContext.java
new file mode 100644
index 00000000..272c3e90
--- /dev/null
+++ b/framework/src/onos/core/api/src/main/java/org/onosproject/codec/CodecContext.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2014 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.codec;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+/**
+ * Context for codecs to use while encoding/decoding.
+ */
+public interface CodecContext {
+
+ /**
+ * Returns the JSON object mapper.
+ *
+ * @return object mapper
+ */
+ ObjectMapper mapper();
+
+ /**
+ * Returns the JSON codec for the specified entity class.
+ *
+ * @param entityClass entity class
+ * @param <T> entity type
+ * @return JSON codec; null if no codec available for the class
+ */
+ <T> JsonCodec<T> codec(Class<T> entityClass);
+
+ /**
+ * Returns reference to the specified service implementation.
+ *
+ * @param serviceClass service class
+ * @param <T> service type
+ * @return JSON codec; null if no codec available for the class
+ */
+ <T> T getService(Class<T> serviceClass);
+
+}