aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/core/api/src/main/java/org/onosproject/core/Application.java
diff options
context:
space:
mode:
Diffstat (limited to 'framework/src/onos/core/api/src/main/java/org/onosproject/core/Application.java')
-rw-r--r--framework/src/onos/core/api/src/main/java/org/onosproject/core/Application.java87
1 files changed, 87 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/core/Application.java b/framework/src/onos/core/api/src/main/java/org/onosproject/core/Application.java
new file mode 100644
index 00000000..fca53843
--- /dev/null
+++ b/framework/src/onos/core/api/src/main/java/org/onosproject/core/Application.java
@@ -0,0 +1,87 @@
+/*
+ * Copyright 2015 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.core;
+
+import org.onosproject.security.Permission;
+
+import java.net.URI;
+import java.util.List;
+import java.util.Optional;
+import java.util.Set;
+
+/**
+ * Abstraction of a network control/management application.
+ */
+public interface Application {
+
+ /**
+ * Returns the application name id.
+ *
+ * @return application identifier
+ */
+ ApplicationId id();
+
+ /**
+ * Returns the application version.
+ *
+ * @return application version
+ */
+ Version version();
+
+ /**
+ * Returns description of the application.
+ *
+ * @return application description text
+ */
+ String description();
+
+ /**
+ * Returns the name of the application origin, group or company.
+ *
+ * @return application origin
+ */
+ String origin();
+
+ /**
+ * Returns the role of the application.
+ *
+ * @return application role
+ */
+ ApplicationRole role();
+
+ /**
+ * Returns the permissions requested by the application.
+ *
+ * @return requested permissions
+ */
+ Set<Permission> permissions();
+
+ /**
+ * Returns the feature repository URI. Null value signifies that the
+ * application did not provide its own features repository.
+ *
+ * @return optional feature repo URL
+ */
+ Optional<URI> featuresRepo();
+
+ /**
+ * Returns the list of features comprising the application. At least one
+ * feature must be given.
+ *
+ * @return application features
+ */
+ List<String> features();
+}