Detangling incubator: virtual nets, tunnels, resource labels, oh my
- virtual networking moved to /apps/virtual; with CLI & REST API
- tunnels and labels moved to /apps/tunnel; with CLI & REST API; UI disabled for now
- protobuf/models moved to /core/protobuf/models
- defunct grpc/rpc registry stuff left under /graveyard
- compile dependencies on /incubator moved to respective modules for compilation
- run-time dependencies will need to be re-tested for dependent apps
- /graveyard will be removed in not-too-distant future
Change-Id: I0a0b995c635487edcf95a352f50dd162186b0b39
diff --git a/apps/tunnel/BUILD b/apps/tunnel/BUILD
new file mode 100644
index 0000000..c7ef288
--- /dev/null
+++ b/apps/tunnel/BUILD
@@ -0,0 +1,13 @@
+BUNDLES = [
+ "//apps/tunnel/api:onos-apps-tunnel-api",
+ "//apps/tunnel/app:onos-apps-tunnel-app",
+]
+
+onos_app(
+ app_name = "org.onosproject.tunnel",
+ category = "Traffic Engineering",
+ description = "Tunnel Subsystem extension",
+ included_bundles = BUNDLES,
+ title = "Tunnel Subsystem",
+ url = "http://onosproject.org",
+)
diff --git a/apps/tunnel/api/BUILD b/apps/tunnel/api/BUILD
new file mode 100644
index 0000000..c6ca52a
--- /dev/null
+++ b/apps/tunnel/api/BUILD
@@ -0,0 +1,9 @@
+COMPILE_DEPS = CORE_DEPS + JACKSON
+
+TEST_DEPS = TEST_ADAPTERS
+
+osgi_jar_with_tests(
+ test_deps = TEST_DEPS,
+ visibility = ["//visibility:public"],
+ deps = COMPILE_DEPS,
+)
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/ExtraSubjectFactories.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/ExtraSubjectFactories.java
new file mode 100644
index 0000000..08737d6
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/ExtraSubjectFactories.java
@@ -0,0 +1,39 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.domain;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.net.config.SubjectFactory;
+
+/**
+ * Set of subject factories for potential configuration subjects.
+ */
+@Beta
+public final class ExtraSubjectFactories {
+
+ // Construction forbidden
+ private ExtraSubjectFactories() {
+ }
+
+ public static final SubjectFactory<IntentDomainId> INTENT_DOMAIN_SUBJECT_FACTORY =
+ new SubjectFactory<IntentDomainId>(IntentDomainId.class, "domains") {
+ @Override
+ public IntentDomainId createSubject(String key) {
+ return IntentDomainId.valueOf(key);
+ }
+ };
+
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomain.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomain.java
new file mode 100644
index 0000000..7060104
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomain.java
@@ -0,0 +1,124 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.domain;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.net.ConnectPoint;
+import org.onosproject.net.DeviceId;
+
+import java.util.Set;
+
+/**
+ * Representation of an intent domain which includes the set of internal devices,
+ * the set of edge ports, and the implementation of the domain provider.
+ */
+@Beta
+public class IntentDomain {
+
+ private final IntentDomainId id;
+ private String name;
+
+ private Set<DeviceId> internalDevices;
+ private Set<ConnectPoint> edgePorts;
+
+ private IntentDomainProvider provider;
+
+ public IntentDomain(IntentDomainId id, String name,
+ Set<DeviceId> internalDevices,
+ Set<ConnectPoint> edgePorts) {
+ this.id = id;
+ this.name = name;
+ this.internalDevices = internalDevices;
+ this.edgePorts = edgePorts;
+ }
+
+ /**
+ * Returns the id for the intent domain.
+ *
+ * @return intent domain id
+ */
+ public IntentDomainId id() {
+ return id;
+ }
+
+ /**
+ * Returns the friendly name for the intent domain.
+ *
+ * @return intent domain name
+ */
+ public String name() {
+ return name;
+ }
+
+ /**
+ * Returns the set of internal devices for the intent domain (devices under
+ * exclusive control of the intent domain).
+ *
+ * @return set of internal devices
+ */
+ public Set<DeviceId> internalDevices() {
+ return internalDevices;
+ }
+
+ /**
+ * Returns the set of edge ports for the intent domain.
+ *
+ * @return set of edge ports
+ */
+ public Set<ConnectPoint> edgePorts() {
+ return edgePorts;
+ }
+
+ /**
+ * Returns the provider for the intent domain.
+ *
+ * @return intent domain provider
+ */
+ public IntentDomainProvider provider() {
+ return provider;
+ }
+
+ /**
+ * Returns the status of the intent domain. An intent domain is active if it
+ * has an intent domain provider bound, and it is inactive if one is not bound.
+ *
+ * @return true if active; false otherwise
+ */
+ public boolean isActive() {
+ return provider != null;
+ }
+
+ /**
+ * Sets the provider for the intent domain if one is not already set.
+ *
+ * @param provider new intent domain provider
+ */
+ public void setProvider(IntentDomainProvider provider) {
+ // TODO consider checkState depending on caller
+ if (this.provider == null) {
+ this.provider = provider;
+ }
+ }
+
+ /**
+ * Unsets the provider for the intent domain.
+ */
+ public void unsetProvider() {
+ this.provider = null;
+ }
+
+ //TODO add remaining setters (we will probably want to link this to the network config)
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainEvent.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainEvent.java
new file mode 100644
index 0000000..c34e80e
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainEvent.java
@@ -0,0 +1,35 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.domain;
+
+import org.onosproject.event.AbstractEvent;
+
+/**
+ * Describes an intent domain event.
+ */
+public class IntentDomainEvent
+ extends AbstractEvent<IntentDomainEvent.Type, IntentDomain> {
+
+ public enum Type {
+ DOMAIN_ADDED,
+ DOMAIN_MODIFIED,
+ DOMAIN_REMOVED
+ }
+
+ protected IntentDomainEvent(Type type, IntentDomain subject) {
+ super(type, subject);
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainId.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainId.java
new file mode 100644
index 0000000..5140762
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainId.java
@@ -0,0 +1,53 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.domain;
+
+import com.google.common.annotations.Beta;
+import org.onlab.util.Identifier;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+/**
+ * Intent domain identifier.
+ */
+@Beta
+public class IntentDomainId extends Identifier<String> {
+ /**
+ * Creates an intent domain identifier from the specified string representation.
+ *
+ * @param value string value
+ * @return intent identifier
+ */
+ public static IntentDomainId valueOf(String value) {
+ return new IntentDomainId(value);
+ }
+
+ /**
+ * Constructor for serializer.
+ */
+ IntentDomainId() {
+ super(null);
+ }
+
+ /**
+ * Constructs the ID corresponding to a given string value.
+ *
+ * @param value the underlying value of this ID
+ */
+ IntentDomainId(String value) {
+ super(checkNotNull(value, "Intent domain ID cannot be null."));
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainListener.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainListener.java
new file mode 100644
index 0000000..c03b904
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainListener.java
@@ -0,0 +1,27 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.domain;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.event.EventListener;
+
+/**
+ * Listener for intent domain events.
+ */
+@Beta
+public interface IntentDomainListener
+ extends EventListener<IntentDomainEvent> {
+}
\ No newline at end of file
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainProvider.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainProvider.java
new file mode 100644
index 0000000..7c44521
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainProvider.java
@@ -0,0 +1,85 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.domain;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.net.provider.Provider;
+
+import java.util.List;
+import java.util.Set;
+
+/**
+ * FIXME.
+ */
+@Beta
+public interface IntentDomainProvider extends Provider {
+
+ /**
+ * Requests that the provider attempt to satisfy the intent primitive.
+ * The application must apply the context before the intent resource
+ * can be used. Request contexts can be explictly cancelled, or they will
+ * eventually time out so that resources can be reused.
+ *
+ * @param domain intent domain for the request
+ * @param primitive intent primitive
+ * @return intent resources that specify paths that satisfy the request.
+ */
+ //TODO Consider an iterable and/or holds (only hold one or two reservation(s) at a time)
+ List<IntentResource> request(IntentDomain domain, IntentPrimitive primitive);
+
+ /**
+ * Request that the provider attempt to modify an existing resource to satisfy
+ * a new intent primitive. The application must apply the context before
+ * the intent resource can be used.
+ *
+ * @param oldResource the resource to be replaced
+ * @param newResource the resource to be applied
+ * @return request contexts that contain resources to satisfy the intent
+ */
+ IntentResource modify(IntentResource oldResource, IntentResource newResource);
+
+ /**
+ * Requests that the provider release an intent resource.
+ *
+ * @param resource intent resource
+ */
+ void release(IntentResource resource);
+
+ /**
+ * Requests that the provider apply the path from the intent resource.
+ *
+ * @param domainIntentResource request context
+ * @return intent resource that satisfies the intent
+ */
+ IntentResource apply(IntentResource domainIntentResource);
+
+ /**
+ * Requests that the provider cancel the path. Requests that are not applied
+ * will be eventually timed out by the provider.
+ *
+ * @param domainIntentResource the intent resource whose path should be cancelled.
+ */
+ void cancel(IntentResource domainIntentResource);
+
+ /**
+ * Returns all intent resources held by the provider.
+ *
+ * @return set of intent resources
+ */
+ Set<IntentResource> getResources();
+}
+
+
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainProviderRegistry.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainProviderRegistry.java
new file mode 100644
index 0000000..c3c597d
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainProviderRegistry.java
@@ -0,0 +1,25 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.domain;
+
+import org.onosproject.net.provider.ProviderRegistry;
+
+/**
+ * Abstraction of a intent domain provider registry.
+ */
+public interface IntentDomainProviderRegistry
+ extends ProviderRegistry<IntentDomainProvider, IntentDomainProviderService> {
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainProviderService.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainProviderService.java
new file mode 100644
index 0000000..c74b483
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainProviderService.java
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.domain;
+
+import org.onosproject.net.provider.ProviderService;
+
+/**
+ * Service through which intent domain providers can report intent domain updates.
+ */
+public interface IntentDomainProviderService
+ extends ProviderService<IntentDomainProvider> {
+
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainService.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainService.java
new file mode 100644
index 0000000..0c010de
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainService.java
@@ -0,0 +1,77 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.domain;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.event.ListenerService;
+import org.onosproject.net.DeviceId;
+
+import java.util.List;
+import java.util.Set;
+
+/**
+ * Service for that maintains a graph of intent domains and a registry of intent
+ * domain providers.
+ */
+@Beta
+public interface IntentDomainService
+ extends ListenerService<IntentDomainEvent, IntentDomainListener> {
+
+ /**
+ * Returns the intent domain for the given id.
+ *
+ * @param id id to look up
+ * @return the intent domain; null if none found
+ */
+ IntentDomain getDomain(IntentDomainId id);
+
+ /**
+ * Returns a set of all intent domains.
+ *
+ * @return set of intent domains
+ */
+ Set<IntentDomain> getDomains();
+
+ /**
+ * Returns any network domains associated with the given device id.
+ *
+ * @param deviceId device id to look up
+ * @return set of intent domain
+ */
+ Set<IntentDomain> getDomains(DeviceId deviceId);
+
+ /**
+ * Requests an intent primitive from the intent domain.
+ *
+ * @param domainId id of target domain
+ * @param primitive intent primitive
+ * @return set of intent resources that satisfy the primitive
+ */
+ List<IntentResource> request(IntentDomainId domainId, IntentPrimitive primitive);
+
+ /**
+ * Submits an intent resource to the intent domain for installation.
+ *
+ * @param domainId id of target domain
+ * @param resource intent resource
+ */
+ void submit(IntentDomainId domainId, IntentResource resource);
+}
+
+
+
+
+
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentPrimitive.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentPrimitive.java
new file mode 100644
index 0000000..04164b5
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentPrimitive.java
@@ -0,0 +1,41 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.domain;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.core.ApplicationId;
+
+/**
+ * Abstract base class for intent primitives.
+ */
+@Beta
+public abstract class IntentPrimitive {
+
+ private final ApplicationId appId;
+
+ public IntentPrimitive(ApplicationId appId) {
+ this.appId = appId;
+ }
+
+ /**
+ * The getter for the application ID associated with the intent primitive upon creation.
+ *
+ * @return the application ID associated with the intent primitive
+ */
+ public ApplicationId appId() {
+ return appId;
+ }
+}
\ No newline at end of file
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentResource.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentResource.java
new file mode 100644
index 0000000..aa6aef4
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/IntentResource.java
@@ -0,0 +1,88 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.domain;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.net.ConnectPoint;
+
+
+/**
+ * The abstract base class for the resource that satisfies an intent primitive.
+ */
+@Beta
+public abstract class IntentResource {
+
+ private final IntentPrimitive primitive;
+
+ private final ApplicationId appId;
+ private final ConnectPoint ingress;
+ private final ConnectPoint egress;
+
+ //* QUESTIONABLE ADDITIONS *//
+
+ // TODO add other common fields
+ //String ingressTag;
+ //String egressTag;
+ //etc.
+
+ public IntentResource(IntentPrimitive primitive, ApplicationId appId,
+ ConnectPoint ingress, ConnectPoint egress) {
+ this.appId = appId;
+ this.ingress = ingress;
+ this.egress = egress;
+ this.primitive = primitive;
+ }
+
+ //TODO when is same package tunnelID should be of type tunnelID and netTunnelId not long.
+
+
+ /**
+ * Returns the intent primitive associated with this resource at creation.
+ *
+ * @return this resource's intent primitive.
+ */
+ public IntentPrimitive primitive() {
+ return primitive;
+ }
+
+ /**
+ * Returns the application ID associated with this resource at creation.
+ *
+ * @return this resource's application ID.
+ */
+ public ApplicationId appId() {
+ return appId;
+ }
+
+ /**
+ * Returns the ingress connect point associated with this resource at creation.
+ *
+ * @return this resource's ingress connect point.
+ */
+ public ConnectPoint ingress() {
+ return ingress;
+ }
+
+ /**
+ * Returns the egress connect point associated with this resource at creation.
+ *
+ * @return this resource's connect point.
+ */
+ public ConnectPoint egress() {
+ return egress;
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/TunnelPrimitive.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/TunnelPrimitive.java
new file mode 100644
index 0000000..5a5518e
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/TunnelPrimitive.java
@@ -0,0 +1,53 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.domain;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.net.ConnectPoint;
+
+/**
+ * Provides connectivity through a domain.
+ */
+@Beta
+public class TunnelPrimitive extends IntentPrimitive {
+
+ private final ConnectPoint one;
+ private final ConnectPoint two;
+
+ public TunnelPrimitive(ApplicationId appId, ConnectPoint one, ConnectPoint two) {
+ super(appId);
+ this.one = one;
+ this.two = two;
+ }
+
+ /**
+ * The getter for the first connection point associated with a tunnel.
+ *
+ * @return the first connection point
+ */
+ public ConnectPoint one() {
+ return one;
+ }
+
+ /**
+ * The getter for the second connection point associated with a tunnel.
+ * @return the second connection point
+ */
+ public ConnectPoint two() {
+ return two;
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/package-info.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/package-info.java
new file mode 100644
index 0000000..c4092aa
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/domain/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.
+ */
+
+/**
+ * Subsystem for network intent domains.
+ */
+package org.onosproject.incubator.net.domain;
\ No newline at end of file
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/DefaultLabelResource.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/DefaultLabelResource.java
new file mode 100644
index 0000000..9c5a6c0
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/DefaultLabelResource.java
@@ -0,0 +1,98 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label;
+
+import java.util.Objects;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.net.Annotations;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.provider.ProviderId;
+import static com.google.common.base.MoreObjects.toStringHelper;
+
+/**
+ * the implementation of a label resource of a device.
+ */
+@Beta
+public final class DefaultLabelResource implements LabelResource {
+
+ private DeviceId deviceId;
+
+ private LabelResourceId labelResourceId;
+
+ /**
+ * Initialize a label resource object.
+ * @param deviceId device identifier
+ * @param labelResourceId label resource id
+ */
+ public DefaultLabelResource(String deviceId, long labelResourceId) {
+ this.deviceId = DeviceId.deviceId(deviceId);
+ this.labelResourceId = LabelResourceId.labelResourceId(labelResourceId);
+ }
+
+ /**
+ * Initialize a label resource object.
+ * @param deviceId device identifier
+ * @param labelResourceId label resource id
+ */
+ public DefaultLabelResource(DeviceId deviceId,
+ LabelResourceId labelResourceId) {
+ this.deviceId = deviceId;
+ this.labelResourceId = labelResourceId;
+ }
+
+ @Override
+ public DeviceId deviceId() {
+ return deviceId;
+ }
+
+ @Override
+ public LabelResourceId labelResourceId() {
+ return labelResourceId;
+ }
+
+ @Override
+ public Annotations annotations() {
+ return null;
+ }
+
+ @Override
+ public ProviderId providerId() {
+ return null;
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(deviceId, labelResourceId);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (obj instanceof DefaultLabelResource) {
+ DefaultLabelResource that = (DefaultLabelResource) obj;
+ return Objects.equals(this.deviceId, that.deviceId)
+ && Objects.equals(this.labelResourceId,
+ that.labelResourceId);
+ }
+ return false;
+ }
+
+ @Override
+ public String toString() {
+ return toStringHelper(this).add("deviceId", deviceId)
+ .add("labelResourceId", labelResourceId).toString();
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResource.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResource.java
new file mode 100644
index 0000000..669c020
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResource.java
@@ -0,0 +1,41 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.net.Annotated;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.NetworkResource;
+import org.onosproject.net.Provided;
+
+/**
+ * Representation of label resource.
+ */
+@Beta
+public interface LabelResource extends Annotated, Provided, NetworkResource {
+ /**
+ * Returns device id.
+ * @return DeviceId
+ */
+ DeviceId deviceId();
+
+ /**
+ * Returns label resource identifier.
+ *
+ * @return resource id
+ */
+ LabelResourceId labelResourceId();
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceAdminService.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceAdminService.java
new file mode 100644
index 0000000..28bf86b
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceAdminService.java
@@ -0,0 +1,66 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.net.DeviceId;
+
+/**
+ * Service for managing label resource.
+ */
+@Beta
+public interface LabelResourceAdminService {
+ /**
+ * Creates the only label resource of some device id from begin label to end
+ * label.
+ *
+ * @param deviceId device identifier
+ * @param beginLabel represents for the first label id in the range of label
+ * pool
+ * @param endLabel represents for the last label id in the range of label
+ * pool
+ * @return success or fail
+ */
+ boolean createDevicePool(DeviceId deviceId, LabelResourceId beginLabel,
+ LabelResourceId endLabel);
+
+ /**
+ * Creates the only global label resource pool.
+ *
+ * @param beginLabel represents for the first label id in the range of label
+ * pool
+ * @param endLabel represents for the last label id in the range of label
+ * pool
+ * @return success or fail
+ */
+ boolean createGlobalPool(LabelResourceId beginLabel,
+ LabelResourceId endLabel);
+
+ /**
+ * Destroys a label resource pool of a specific device id.
+ *
+ * @param deviceId device identifier
+ * @return success or fail
+ */
+ boolean destroyDevicePool(DeviceId deviceId);
+
+ /**
+ * Destroys the global label resource pool.
+ *
+ * @return success or fail
+ */
+ boolean destroyGlobalPool();
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceDelegate.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceDelegate.java
new file mode 100644
index 0000000..2dde408
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceDelegate.java
@@ -0,0 +1,27 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.store.StoreDelegate;
+
+/**
+ * Label resource store delegate.
+ */
+@Beta
+public interface LabelResourceDelegate extends StoreDelegate<LabelResourceEvent> {
+
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceEvent.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceEvent.java
new file mode 100644
index 0000000..a21ae3b
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceEvent.java
@@ -0,0 +1,55 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.event.AbstractEvent;
+
+/**
+ * Describes label resource event.
+ */
+@Beta
+public final class LabelResourceEvent
+ extends AbstractEvent<LabelResourceEvent.Type, LabelResourcePool> {
+
+ /**
+ * Type of label resource event.
+ */
+ public enum Type {
+ /**
+ * Signifies that a new pool has been administratively created.
+ */
+ POOL_CREATED,
+ /**
+ * Signifies that a new pool has been administratively destroyed.
+ */
+ POOL_DESTROYED,
+ /**
+ * Signifies that a new pool has been administratively changed.
+ */
+ POOL_CAPACITY_CHANGED
+ }
+
+ /**
+ * Creates an event of a given type and the given LabelResourcePool.
+ *
+ * @param type event type
+ * @param subject pool
+ */
+ public LabelResourceEvent(Type type, LabelResourcePool subject) {
+ super(type, subject);
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceId.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceId.java
new file mode 100644
index 0000000..99d7f69
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceId.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label;
+
+import com.google.common.annotations.Beta;
+import org.onlab.util.Identifier;
+
+/**
+ * Representation of a label.
+ */
+@Beta
+public final class LabelResourceId extends Identifier<Long> {
+
+ /**
+ * Creates a new label identifier.
+ *
+ * @param labelResourceId backing identifier value
+ * @return label identifier
+ */
+ public static LabelResourceId labelResourceId(long labelResourceId) {
+ return new LabelResourceId(labelResourceId);
+ }
+
+ // Public construction is prohibited
+ private LabelResourceId(long labelId) {
+ super(labelId);
+ }
+
+ /**
+ * Returns label identifier.
+ *
+ * @return label identifier
+ */
+ public long labelId() {
+ return identifier;
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceListener.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceListener.java
new file mode 100644
index 0000000..113dd2a
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceListener.java
@@ -0,0 +1,27 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.event.EventListener;
+
+/**
+ * Entity capable of receiving label resource related events.
+ */
+@Beta
+public interface LabelResourceListener extends EventListener<LabelResourceEvent> {
+
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourcePool.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourcePool.java
new file mode 100644
index 0000000..d34bb97
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourcePool.java
@@ -0,0 +1,191 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label;
+
+import static com.google.common.base.Preconditions.checkArgument;
+
+import java.util.Collections;
+import java.util.Objects;
+import java.util.Set;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.net.DeviceId;
+
+import com.google.common.base.MoreObjects;
+import com.google.common.collect.ImmutableSet;
+
+/**
+ * Abstraction of the capacity of device label resource or global label
+ * resource. It's contiguous range of label resource. When a application apply
+ * some labels of some device, first catch from Set that store
+ * available labels, if the size of the Set less than the apply number, then get
+ * labels by calculating with three attributes, beginLabel,endLabel and
+ * currentUsedMaxLabelId.
+ */
+@Beta
+public class LabelResourcePool {
+
+ private final DeviceId deviceId;
+ private final LabelResourceId beginLabel;
+ private final LabelResourceId endLabel;
+ private final long totalNum; // capacity of label resource pool
+ private final long usedNum; // have used label number
+ private final LabelResourceId currentUsedMaxLabelId; // the maximal label
+ // number id
+ private ImmutableSet<LabelResource> releaseLabelId; // Set of released label
+
+ /**
+ * Creates a pool by device id,begin label id,end label id.
+ *
+ * @param deviceId device identifier
+ * @param beginLabel represents for the first label id in the range of label
+ * resource pool
+ * @param endLabel represents for the last label id in the range of label
+ * resource pool
+ */
+ public LabelResourcePool(String deviceId, long beginLabel, long endLabel) {
+ this(deviceId, beginLabel, endLabel, endLabel - beginLabel + 1, 0L,
+ beginLabel, ImmutableSet.copyOf(Collections.emptySet()));
+ }
+
+ /**
+ * Creates a pool by device id,begin label id,end label id.
+ * Used to update a pool in the store.
+ *
+ * @param deviceId device identifier
+ * @param beginLabel represents for the first label id in the range of label
+ * resource pool
+ * @param endLabel represents for the last label id in the range of label
+ * resource pool
+ * @param totalNum capacity of label resource pool
+ * @param usedNum have used label number
+ * @param currentUsedMaxLabelId the maximal label number id
+ * @param releaseLabelId Set of released label
+ */
+ public LabelResourcePool(String deviceId, long beginLabel, long endLabel,
+ long totalNum, long usedNum,
+ long currentUsedMaxLabelId,
+ ImmutableSet<LabelResource> releaseLabelId) {
+ checkArgument(endLabel >= beginLabel,
+ "endLabel %s must be greater than or equal to beginLabel %s",
+ endLabel, beginLabel);
+ this.deviceId = DeviceId.deviceId(deviceId);
+ this.beginLabel = LabelResourceId.labelResourceId(beginLabel);
+ this.endLabel = LabelResourceId.labelResourceId(endLabel);
+ this.totalNum = totalNum;
+ this.usedNum = usedNum;
+ this.currentUsedMaxLabelId = LabelResourceId
+ .labelResourceId(currentUsedMaxLabelId);
+ this.releaseLabelId = releaseLabelId;
+ }
+
+ /**
+ * Returns a device id.
+ *
+ * @return DeviceId
+ */
+ public DeviceId deviceId() {
+ return deviceId;
+ }
+
+ /**
+ * Returns a begin Label id.
+ *
+ * @return begin Label id
+ */
+ public LabelResourceId beginLabel() {
+ return beginLabel;
+ }
+
+ /**
+ * Returns an end Label id.
+ *
+ * @return end Label id
+ */
+ public LabelResourceId endLabel() {
+ return endLabel;
+ }
+
+ /**
+ * Returns a begin Label id.
+ *
+ * @return current Used Maximal Label Id
+ */
+ public LabelResourceId currentUsedMaxLabelId() {
+ return currentUsedMaxLabelId;
+ }
+
+ /**
+ * Returns total number.
+ *
+ * @return the total label number
+ */
+ public long totalNum() {
+ return totalNum;
+ }
+
+ /**
+ * Returns used number.
+ *
+ * @return the used label number
+ */
+ public long usedNum() {
+ return usedNum;
+ }
+
+ /**
+ * Returns the Set of released label before.
+ *
+ * @return the Set of LabelResource
+ */
+ public Set<LabelResource> releaseLabelId() {
+ return releaseLabelId;
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(this.deviceId, this.beginLabel, this.endLabel,
+ this.totalNum, this.usedNum,
+ this.currentUsedMaxLabelId, this.releaseLabelId);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (obj instanceof LabelResourcePool) {
+ LabelResourcePool that = (LabelResourcePool) obj;
+ return Objects.equals(this.deviceId, that.deviceId)
+ && Objects.equals(this.beginLabel, that.beginLabel)
+ && Objects.equals(this.endLabel, that.endLabel)
+ && Objects.equals(this.totalNum, that.totalNum)
+ && Objects.equals(this.usedNum, that.usedNum)
+ && Objects.equals(this.currentUsedMaxLabelId,
+ that.currentUsedMaxLabelId)
+ && Objects.equals(this.releaseLabelId, that.releaseLabelId);
+ }
+ return false;
+ }
+
+ @Override
+ public String toString() {
+ // TODO Auto-generated method stub
+ return MoreObjects.toStringHelper(this).add("deviceId", this.deviceId)
+ .add("beginLabel", this.beginLabel)
+ .add("endLabel", this.endLabel).add("totalNum", this.totalNum)
+ .add("usedNum", this.usedNum)
+ .add("currentUsedMaxLabelId", this.currentUsedMaxLabelId)
+ .add("releaseLabelId", this.releaseLabelId).toString();
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceProvider.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceProvider.java
new file mode 100644
index 0000000..986993e
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceProvider.java
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.net.provider.Provider;
+
+/**
+ * Abstraction of an entity providing information about label resource
+ * to the core.
+ */
+@Beta
+public interface LabelResourceProvider extends Provider {
+
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceProviderRegistry.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceProviderRegistry.java
new file mode 100644
index 0000000..c6130cb
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceProviderRegistry.java
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.net.provider.ProviderRegistry;
+
+/**
+ * Abstraction of an label resource provider registry.
+ */
+@Beta
+public interface LabelResourceProviderRegistry
+ extends ProviderRegistry<LabelResourceProvider, LabelResourceProviderService> {
+
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceProviderService.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceProviderService.java
new file mode 100644
index 0000000..b7fd072
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceProviderService.java
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.provider.ProviderService;
+
+/**
+ * Means for injecting label information into the core.
+ */
+@Beta
+public interface LabelResourceProviderService extends ProviderService<LabelResourceProvider> {
+
+ /**
+ * Signals that a device label resource pool has been detected.
+ * @param deviceId device identifier
+ * @param beginLabel the begin label number of resource
+ * @param endLabel the end label number of resource
+ */
+ void deviceLabelResourcePoolDetected(DeviceId deviceId,
+ LabelResourceId beginLabel,
+ LabelResourceId endLabel);
+
+ /**
+ * Signals that an label resource pool has been destroyed.
+ * @param deviceId device identifier
+ */
+ void deviceLabelResourcePoolDestroyed(DeviceId deviceId);
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceRequest.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceRequest.java
new file mode 100644
index 0000000..776e068
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceRequest.java
@@ -0,0 +1,119 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label;
+
+import java.util.Collection;
+import java.util.Objects;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.net.DeviceId;
+
+import com.google.common.base.MoreObjects;
+import com.google.common.collect.ImmutableSet;
+
+/**
+ * Represents for a label request.
+ */
+@Beta
+public class LabelResourceRequest {
+
+ private final DeviceId deviceId;
+ private final Type type;
+ private final long applyNum;
+ private ImmutableSet<LabelResource> releaseCollection;
+
+ /**
+ * Creates LabelResourceRequest object.
+ * @param deviceId device identifier
+ * @param type request type
+ * @param applyNum apply the number of labels
+ * @param releaseCollection Set of released label
+ */
+ public LabelResourceRequest(DeviceId deviceId,
+ Type type,
+ long applyNum,
+ ImmutableSet<LabelResource> releaseCollection) {
+ this.deviceId = deviceId;
+ this.type = type;
+ this.applyNum = applyNum;
+ this.releaseCollection = releaseCollection;
+ }
+ /**
+ * Returns a device id.
+ * @return DeviceId
+ */
+ public DeviceId deviceId() {
+ return deviceId;
+ }
+
+ /**
+ * Returns request type.
+ * @return Type
+ */
+ public Type type() {
+ return type;
+ }
+
+ /**
+ * Returns apply label number.
+ * @return label number
+ */
+ public long applyNum() {
+ return applyNum;
+ }
+
+ /**
+ * Returns the collection of release labels.
+ * @return Collection of DefaultLabelResource
+ */
+ public Collection<LabelResource> releaseCollection() {
+ return releaseCollection;
+ }
+
+ /**
+ * Request type.
+ */
+ public enum Type {
+ APPLY, //apple label request
+ RELEASE //release label request
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(this.deviceId, this.applyNum, this.type,
+ this.releaseCollection);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (obj instanceof LabelResourceRequest) {
+ LabelResourceRequest that = (LabelResourceRequest) obj;
+ return Objects.equals(this.deviceId, that.deviceId)
+ && Objects.equals(this.applyNum, that.applyNum)
+ && Objects.equals(this.type, that.type)
+ && Objects.equals(this.releaseCollection,
+ that.releaseCollection);
+ }
+ return false;
+ }
+
+ @Override
+ public String toString() {
+ return MoreObjects.toStringHelper(this).add("deviceId", this.deviceId)
+ .add("applyNum", this.applyNum).add("type", this.type)
+ .add("releaseCollection", this.releaseCollection).toString();
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceService.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceService.java
new file mode 100644
index 0000000..91cdedc
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceService.java
@@ -0,0 +1,115 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label;
+
+import java.util.Collection;
+import java.util.Set;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.event.ListenerService;
+import org.onosproject.net.DeviceId;
+
+import com.google.common.collect.Multimap;
+
+/**
+ * Service for providing label resource allocation.
+ */
+@Beta
+public interface LabelResourceService
+ extends ListenerService<LabelResourceEvent, LabelResourceListener> {
+
+ /**
+ * Returns labels from resource pool by a specific device id.
+ *
+ * @param deviceId device identifier
+ * @param applyNum the applying number
+ * @return collection of applying labels
+ */
+ Collection<LabelResource> applyFromDevicePool(DeviceId deviceId,
+ long applyNum);
+
+ /**
+ * Returns labels from the global label resource pool.
+ *
+ * @param applyNum the applying number
+ * @return collection of applying labels
+ */
+ Collection<LabelResource> applyFromGlobalPool(long applyNum);
+
+ /**
+ * Releases unused labels to device pools .
+ *
+ * @param release the collection of releasing labels
+ * @return success or fail
+ */
+ boolean releaseToDevicePool(Multimap<DeviceId, LabelResource> release);
+
+ /**
+ * Releases unused labels to the global resource pool.
+ *
+ * @param release release the collection of releasing labels
+ * @return success or fail
+ */
+ boolean releaseToGlobalPool(Set<LabelResourceId> release);
+
+ /**
+ * Judges if the pool of a specific device id is full.
+ *
+ * @param deviceId device identifier
+ * @return yes or no
+ */
+ boolean isDevicePoolFull(DeviceId deviceId);
+
+ /**
+ * Judges if the global resource pool is full.
+ *
+ * @return yes or no
+ */
+ boolean isGlobalPoolFull();
+
+ /**
+ * Returns the unused label number of a label resource pool by a specific device
+ * id.
+ *
+ * @param deviceId device identifier
+ * @return number of unused labels
+ */
+ long getFreeNumOfDevicePool(DeviceId deviceId);
+
+ /**
+ * Returns the unused label number of a global label resource pool.
+ *
+ * @return number of unused labels
+ */
+ long getFreeNumOfGlobalPool();
+
+ /**
+ * Returns the label resource pool of a label resource by a specific device
+ * id.
+ *
+ * @param deviceId device identifier
+ * @return the device label resource pool
+ */
+ LabelResourcePool getDeviceLabelResourcePool(DeviceId deviceId);
+
+ /**
+ * Returns the global label resource pool.
+ *
+ * @return the global label resource pool
+ */
+ LabelResourcePool getGlobalLabelResourcePool();
+
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceStore.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceStore.java
new file mode 100644
index 0000000..b27cefe
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceStore.java
@@ -0,0 +1,154 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label;
+
+import java.util.Collection;
+import java.util.Set;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.net.DeviceId;
+import org.onosproject.store.Store;
+
+import com.google.common.collect.Multimap;
+
+/**
+ * Manages inventory of label; not intended for direct use.
+ *
+ */
+@Beta
+public interface LabelResourceStore
+ extends Store<LabelResourceEvent, LabelResourceDelegate> {
+
+ /**
+ * Creates a label resource of some device id from begin label to end label.
+ *
+ * @param deviceId device identifier
+ * @param beginLabel represents for the first label id in the range of label
+ * pool
+ * @param endLabel represents for the last label id in the range of label
+ * pool
+ * @return success or fail
+ */
+ boolean createDevicePool(DeviceId deviceId, LabelResourceId beginLabel,
+ LabelResourceId endLabel);
+
+ /**
+ * Creates the global label resource pool.
+ *
+ * @param beginLabel represents for the first label id in the range of label
+ * pool
+ * @param endLabel represents for the last label id in the range of label
+ * pool
+ * @return success or fail
+ */
+ boolean createGlobalPool(LabelResourceId beginLabel,
+ LabelResourceId endLabel);
+
+ /**
+ * Destroys a label resource pool of a specific device id.
+ *
+ * @param deviceId device identifier
+ * @return success or fail
+ */
+ boolean destroyDevicePool(DeviceId deviceId);
+
+ /**
+ * Destroys a the global label resource pool.
+ *
+ * @return success or fail
+ */
+ boolean destroyGlobalPool();
+
+ /**
+ * Returns labels from resource pool by a specific device id.
+ *
+ * @param deviceId device identifier
+ * @param applyNum the applying number
+ * @return collection of applying labels
+ */
+ Collection<LabelResource> applyFromDevicePool(DeviceId deviceId,
+ long applyNum);
+
+ /**
+ * Returns labels from the global label resource pool.
+ *
+ * @param applyNum apply the number of labels
+ * @return collection of labels
+ */
+ Collection<LabelResource> applyFromGlobalPool(long applyNum);
+
+ /**
+ * Releases unused labels to device pools .
+ *
+ * @param release the collection of releasing labels
+ * @return success or fail
+ */
+ boolean releaseToDevicePool(Multimap<DeviceId, LabelResource> release);
+
+ /**
+ * Releases unused labels to the global resource pool.
+ *
+ * @param release release the collection of releasing labels
+ * @return success or fail
+ */
+ boolean releaseToGlobalPool(Set<LabelResourceId> release);
+
+ /**
+ * Judges if the pool of a specific device id is full.
+ *
+ * @param deviceId device identifier
+ * @return yes or no
+ */
+ boolean isDevicePoolFull(DeviceId deviceId);
+
+ /**
+ * Judges if the global resource pool is full.
+ *
+ * @return yes or no
+ */
+ boolean isGlobalPoolFull();
+
+ /**
+ * Returns the unused label number of a label resource pool by a specific device
+ * id.
+ *
+ * @param deviceId device identifier
+ * @return number of unused labels
+ */
+ long getFreeNumOfDevicePool(DeviceId deviceId);
+
+ /**
+ * Returns the unused number of a global label resource pool.
+ *
+ * @return number of unused labels
+ */
+ long getFreeNumOfGlobalPool();
+
+ /**
+ * Returns the label resource pool by a specific device id.
+ *
+ * @param deviceId device identifier
+ * @return the device label resource pool
+ */
+ LabelResourcePool getDeviceLabelResourcePool(DeviceId deviceId);
+
+ /**
+ * Returns the global label resource pool.
+ *
+ * @return the global label resource pool
+ */
+ LabelResourcePool getGlobalLabelResourcePool();
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/package-info.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/package-info.java
new file mode 100644
index 0000000..7a8de6f
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/resource/label/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.
+ */
+
+/**
+ * Service for reserving labels as network resources.
+ */
+package org.onosproject.incubator.net.resource.label;
\ No newline at end of file
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/DefaultLabelStack.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/DefaultLabelStack.java
new file mode 100644
index 0000000..1c7ff8c
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/DefaultLabelStack.java
@@ -0,0 +1,68 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import com.google.common.base.MoreObjects;
+import com.google.common.collect.ImmutableList;
+import org.onosproject.incubator.net.resource.label.LabelResourceId;
+import java.util.List;
+import java.util.Objects;
+
+/**
+ * Default implementation of label stack.
+ */
+public class DefaultLabelStack implements LabelStack {
+
+ private final List<LabelResourceId> labelResources;
+
+ /**
+ * Creates label stack.
+ *
+ * @param labelResources contiguous label ids that comprise the path
+ */
+ public DefaultLabelStack(List<LabelResourceId> labelResources) {
+ this.labelResources = ImmutableList.copyOf(labelResources);
+ }
+
+ @Override
+ public List<LabelResourceId> labelResources() {
+ return labelResources;
+ }
+
+ @Override
+ public String toString() {
+ return MoreObjects.toStringHelper(this)
+ .add("labelResources", labelResources)
+ .toString();
+ }
+
+ @Override
+ public int hashCode() {
+ return labelResources.hashCode();
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (obj instanceof DefaultLabelStack) {
+ final DefaultLabelStack other = (DefaultLabelStack) obj;
+ return Objects.equals(this.labelResources, other.labelResources);
+ }
+ return false;
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/DefaultOpticalTunnelEndPoint.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/DefaultOpticalTunnelEndPoint.java
new file mode 100644
index 0000000..c33d713
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/DefaultOpticalTunnelEndPoint.java
@@ -0,0 +1,131 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import static com.google.common.base.MoreObjects.toStringHelper;
+
+import java.util.Objects;
+import java.util.Optional;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.net.AbstractModel;
+import org.onosproject.net.Annotations;
+import org.onosproject.net.ElementId;
+import org.onosproject.net.PortNumber;
+import org.onosproject.net.provider.ProviderId;
+
+/**
+ * Default optical tunnel point model implementation.
+ */
+@Beta
+public class DefaultOpticalTunnelEndPoint extends AbstractModel implements OpticalTunnelEndPoint {
+ private final Optional<ElementId> elementId;
+ private final Optional<PortNumber> portNumber;
+ private final Optional<OpticalTunnelEndPoint> parentPoint;
+ private final Type type;
+ private final OpticalLogicId id;
+ private final boolean isGlobal;
+
+ /**
+ * Creates a optical tunnel point attributed to the specified provider (may be null).
+ * if provider is null, which means the optical tunnel point is not managed by the SB.
+ *
+ * @param providerId tunnelProvider Id
+ * @param elementId parent network element
+ * @param number port number
+ * @param parentPoint parent port or parent label
+ * @param type port type
+ * @param id LabelId
+ * @param isGlobal indicator whether the label is global significant or not
+ * @param annotations optional key/value annotations
+ */
+ public DefaultOpticalTunnelEndPoint(ProviderId providerId, Optional<ElementId> elementId,
+ Optional<PortNumber> number, Optional<OpticalTunnelEndPoint> parentPoint,
+ Type type, OpticalLogicId id, boolean isGlobal, Annotations... annotations) {
+ super(providerId, annotations);
+ this.elementId = elementId;
+ this.portNumber = number;
+ this.parentPoint = parentPoint;
+ this.id = id;
+ this.type = type;
+ this.isGlobal = isGlobal;
+ }
+
+ @Override
+ public OpticalLogicId id() {
+ return id;
+ }
+
+ @Override
+ public Optional<ElementId> elementId() {
+ return elementId;
+ }
+
+ @Override
+ public Optional<PortNumber> portNumber() {
+ return portNumber;
+ }
+
+ @Override
+ public Optional<OpticalTunnelEndPoint> parentPoint() {
+ return parentPoint;
+ }
+
+ @Override
+ public boolean isGlobal() {
+ return isGlobal;
+ }
+
+ @Override
+ public Type type() {
+ return type;
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(elementId, portNumber, parentPoint, id);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (obj instanceof DefaultOpticalTunnelEndPoint) {
+ final DefaultOpticalTunnelEndPoint other = (DefaultOpticalTunnelEndPoint) obj;
+ return Objects.equals(this.id, other.id) &&
+ Objects.equals(this.type, other.type) &&
+ Objects.equals(this.isGlobal, other.isGlobal) &&
+ Objects.equals(this.elementId, other.elementId) &&
+ Objects.equals(this.portNumber, other.portNumber) &&
+ Objects.equals(this.parentPoint, other.parentPoint);
+ }
+ return false;
+ }
+
+ @Override
+ public String toString() {
+ return toStringHelper(this)
+ .add("elementId", elementId)
+ .add("portNumber", portNumber)
+ .add("parentPoint", parentPoint)
+ .add("type", type)
+ .add("id", id)
+ .add("isGlobal", isGlobal)
+ .toString();
+ }
+
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/DefaultTunnel.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/DefaultTunnel.java
new file mode 100644
index 0000000..7c639de
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/DefaultTunnel.java
@@ -0,0 +1,236 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import static com.google.common.base.MoreObjects.toStringHelper;
+
+import java.util.Objects;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.core.GroupId;
+import org.onosproject.net.AbstractModel;
+import org.onosproject.net.Annotations;
+import org.onosproject.net.NetworkResource;
+import org.onosproject.net.Path;
+import org.onosproject.net.provider.ProviderId;
+
+/**
+ * The default implementation of an network tunnel. supports for creating a
+ * tunnel by connect point ,IP address, MAC address, device and so on.
+ */
+@Beta
+public final class DefaultTunnel extends AbstractModel implements Tunnel {
+
+ private final TunnelEndPoint src; // a source point of tunnel.
+ private final TunnelEndPoint dst; // a destination point of tunnel.
+ private final State state;
+ private final Type type; // tunnel type
+ private final GroupId groupId; // represent for a group flow table
+ // which a tunnel match up
+ // tunnel producer
+ private final TunnelId tunnelId; // tunnel identify generated by
+ // ONOS as primary key
+ private final TunnelName tunnelName; // name of a tunnel
+ private final Path path;
+ private final NetworkResource networkRes; // network resource to carry label stack
+
+ /**
+ * Creates an active infrastructure tunnel using the supplied information.
+ *
+ * @param producerName provider identity
+ * @param src tunnel source
+ * @param dst tunnel destination
+ * @param type tunnel type
+ * @param groupId groupId
+ * @param tunnelId tunnelId
+ * @param tunnelName tunnel name
+ * @param path the path of tunnel
+ * @param annotations optional key/value annotations
+ */
+ public DefaultTunnel(ProviderId producerName, TunnelEndPoint src,
+ TunnelEndPoint dst, Type type, GroupId groupId,
+ TunnelId tunnelId, TunnelName tunnelName, Path path,
+ Annotations... annotations) {
+ this(producerName, src, dst, type, Tunnel.State.ACTIVE, groupId,
+ tunnelId, tunnelName, path, annotations);
+ }
+
+ /**
+ * Creates an tunnel using the supplied information.
+ *
+ * @param producerName provider identity
+ * @param src tunnel source
+ * @param dst tunnel destination
+ * @param type tunnel type
+ * @param state tunnel state
+ * @param groupId groupId
+ * @param tunnelId tunnelId
+ * @param tunnelName tunnel name
+ * @param path the path of tunnel
+ * @param annotations optional key/value annotations
+ */
+ public DefaultTunnel(ProviderId producerName, TunnelEndPoint src,
+ TunnelEndPoint dst, Type type, State state,
+ GroupId groupId, TunnelId tunnelId,
+ TunnelName tunnelName, Path path, Annotations... annotations) {
+ super(producerName, annotations);
+ this.src = src;
+ this.dst = dst;
+ this.type = type;
+ this.state = state;
+ this.groupId = groupId;
+ this.tunnelId = tunnelId;
+ this.tunnelName = tunnelName;
+ this.path = path;
+ this.networkRes = null;
+ }
+
+ /**
+ * Creates an active infrastructure tunnel using the supplied information.
+ *
+ * @param producerName provider identity
+ * @param src tunnel source
+ * @param dst tunnel destination
+ * @param type tunnel type
+ * @param groupId groupId
+ * @param tunnelId tunnelId
+ * @param tunnelName tunnel name
+ * @param path the path of tunnel
+ * @param networkRes network resource of tunnel
+ * @param annotations optional key/value annotations
+ */
+ public DefaultTunnel(ProviderId producerName, TunnelEndPoint src,
+ TunnelEndPoint dst, Type type, GroupId groupId,
+ TunnelId tunnelId, TunnelName tunnelName, Path path,
+ NetworkResource networkRes, Annotations... annotations) {
+ this(producerName, src, dst, type, Tunnel.State.ACTIVE, groupId,
+ tunnelId, tunnelName, path, networkRes, annotations);
+ }
+
+ /**
+ * Creates an tunnel using the supplied information.
+ *
+ * @param producerName provider identity
+ * @param src tunnel source
+ * @param dst tunnel destination
+ * @param type tunnel type
+ * @param state tunnel state
+ * @param groupId groupId
+ * @param tunnelId tunnelId
+ * @param tunnelName tunnel name
+ * @param path the path of tunnel
+ * @param networkRes network resource of tunnel
+ * @param annotations optional key/value annotations
+ */
+ public DefaultTunnel(ProviderId producerName, TunnelEndPoint src,
+ TunnelEndPoint dst, Type type, State state,
+ GroupId groupId, TunnelId tunnelId,
+ TunnelName tunnelName, Path path, NetworkResource networkRes,
+ Annotations... annotations) {
+ super(producerName, annotations);
+ this.src = src;
+ this.dst = dst;
+ this.type = type;
+ this.state = state;
+ this.groupId = groupId;
+ this.tunnelId = tunnelId;
+ this.tunnelName = tunnelName;
+ this.path = path;
+ this.networkRes = networkRes;
+ }
+
+ @Override
+ public TunnelEndPoint src() {
+ return src;
+ }
+
+ @Override
+ public TunnelEndPoint dst() {
+ return dst;
+ }
+
+ @Override
+ public Type type() {
+ return type;
+ }
+
+ @Override
+ public State state() {
+ return state;
+ }
+
+ @Override
+ public NetworkResource resource() {
+ return networkRes;
+ }
+
+ @Override
+ public TunnelId tunnelId() {
+ return tunnelId;
+ }
+
+ @Override
+ public GroupId groupId() {
+ return groupId;
+ }
+
+ @Override
+ public TunnelName tunnelName() {
+ return tunnelName;
+ }
+
+
+ @Override
+ public Path path() {
+ return path;
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(src, dst, type, groupId, tunnelId, tunnelName,
+ state, path, networkRes);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (obj instanceof DefaultTunnel) {
+ final DefaultTunnel other = (DefaultTunnel) obj;
+ return Objects.equals(this.src, other.src)
+ && Objects.equals(this.dst, other.dst)
+ && Objects.equals(this.type, other.type)
+ && Objects.equals(this.groupId, other.groupId)
+ && Objects.equals(this.tunnelId, other.tunnelId)
+ && Objects.equals(this.tunnelName, other.tunnelName)
+ && Objects.equals(this.state, other.state)
+ && Objects.equals(this.path, other.path)
+ && Objects.equals(this.networkRes, other.networkRes);
+ }
+ return false;
+ }
+
+ @Override
+ public String toString() {
+ return toStringHelper(this).add("src", src).add("dst", dst)
+ .add("type", type).add("state", state).add("groupId", groupId)
+ .add("producerTunnelId", tunnelId)
+ .add("tunnelName", tunnelName)
+ .add("path", path)
+ .add("networkResource", networkRes).toString();
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/DefaultTunnelDescription.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/DefaultTunnelDescription.java
new file mode 100644
index 0000000..505650a
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/DefaultTunnelDescription.java
@@ -0,0 +1,173 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.core.GroupId;
+import org.onosproject.net.AbstractDescription;
+import org.onosproject.net.NetworkResource;
+import org.onosproject.net.Path;
+import org.onosproject.net.SparseAnnotations;
+import org.onosproject.net.provider.ProviderId;
+
+import com.google.common.base.MoreObjects;
+
+/**
+ * Default implementation of immutable tunnel description entity.
+ */
+@Beta
+public class DefaultTunnelDescription extends AbstractDescription
+ implements TunnelDescription {
+
+ private final TunnelId tunnelId;
+ private final TunnelEndPoint src;
+ private final TunnelEndPoint dst;
+ private final Tunnel.Type type;
+ private final GroupId groupId; // represent for a group flow table
+ // which a tunnel match up
+ // tunnel producer
+ private final ProviderId producerName; // tunnel producer name
+ private final TunnelName tunnelName; // name of a tunnel
+ private final Path path;
+ private final NetworkResource networkRes;
+
+ /**
+ * Creates a tunnel description using the supplied information.
+ *
+ * @param id TunnelId
+ * @param src TunnelPoint source
+ * @param dst TunnelPoint destination
+ * @param type tunnel type
+ * @param groupId groupId
+ * @param producerName tunnel producer
+ * @param tunnelName tunnel name
+ * @param path the path of tunnel
+ * @param annotations optional key/value annotations
+ */
+ public DefaultTunnelDescription(TunnelId id, TunnelEndPoint src,
+ TunnelEndPoint dst, Tunnel.Type type,
+ GroupId groupId,
+ ProviderId producerName,
+ TunnelName tunnelName,
+ Path path,
+ SparseAnnotations... annotations) {
+ super(annotations);
+ this.tunnelId = id;
+ this.src = src;
+ this.dst = dst;
+ this.type = type;
+ this.groupId = groupId;
+ this.producerName = producerName;
+ this.tunnelName = tunnelName;
+ this.path = path;
+ this.networkRes = null;
+ }
+
+ /**
+ * Creates a tunnel description using the supplied information.
+ *
+ * @param id TunnelId
+ * @param src TunnelPoint source
+ * @param dst TunnelPoint destination
+ * @param type tunnel type
+ * @param groupId groupId
+ * @param producerName tunnel producer
+ * @param tunnelName tunnel name
+ * @param path the path of tunnel
+ * @param networkRes network resource of tunnel
+ * @param annotations optional key/value annotations
+ */
+ public DefaultTunnelDescription(TunnelId id, TunnelEndPoint src,
+ TunnelEndPoint dst, Tunnel.Type type,
+ GroupId groupId,
+ ProviderId producerName,
+ TunnelName tunnelName,
+ Path path,
+ NetworkResource networkRes,
+ SparseAnnotations... annotations) {
+ super(annotations);
+ this.tunnelId = id;
+ this.src = src;
+ this.dst = dst;
+ this.type = type;
+ this.groupId = groupId;
+ this.producerName = producerName;
+ this.tunnelName = tunnelName;
+ this.path = path;
+ this.networkRes = networkRes;
+ }
+
+ @Override
+ public TunnelId id() {
+ return tunnelId;
+ }
+
+ @Override
+ public TunnelEndPoint src() {
+ return src;
+ }
+
+ @Override
+ public TunnelEndPoint dst() {
+ return dst;
+ }
+
+ @Override
+ public Tunnel.Type type() {
+ return type;
+ }
+
+ @Override
+ public GroupId groupId() {
+ return groupId;
+ }
+
+ @Override
+ public ProviderId producerName() {
+ return producerName;
+ }
+
+ @Override
+ public TunnelName tunnelName() {
+ return tunnelName;
+ }
+
+
+ @Override
+ public Path path() {
+ return path;
+ }
+
+ @Override
+ public NetworkResource resource() {
+ return networkRes;
+ }
+
+ @Override
+ public String toString() {
+ return MoreObjects.toStringHelper(this)
+ .add("tunnelId", id())
+ .add("src", src())
+ .add("dst", dst())
+ .add("type", type())
+ .add("tunnelName", tunnelName())
+ .add("producerName", producerName())
+ .add("groupId", groupId())
+ .add("path", path)
+ .add("resource", networkRes)
+ .toString();
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/DefaultTunnelStatistics.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/DefaultTunnelStatistics.java
new file mode 100644
index 0000000..07a8540
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/DefaultTunnelStatistics.java
@@ -0,0 +1,169 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import com.google.common.annotations.Beta;
+
+import java.time.Duration;
+import java.util.List;
+
+/**
+ * Default implementation of immutable tunnel statistics.
+ */
+@Beta
+public final class DefaultTunnelStatistics implements TunnelStatistics {
+ private final TunnelId tunnelId;
+ private final double bwUtilization;
+ private final double packetLossRatio;
+ private final Duration flowDelay;
+ private final List<String> alarms;
+
+ private DefaultTunnelStatistics(TunnelId tunnelId,
+ double bwUtilization,
+ double packetLossRatio,
+ Duration flowDelay,
+ List<String> alarms) {
+ this.tunnelId = tunnelId;
+ this.bwUtilization = bwUtilization;
+ this.packetLossRatio = packetLossRatio;
+ this.flowDelay = flowDelay;
+ this.alarms = alarms;
+ }
+
+ private DefaultTunnelStatistics() {
+ this.tunnelId = null;
+ this.bwUtilization = 0;
+ this.packetLossRatio = 0;
+ this.flowDelay = null;
+ this.alarms = null;
+ }
+
+
+ @Override
+ public TunnelId id() {
+ return this.tunnelId;
+ }
+
+ @Override
+ public double bandwidthUtilization() {
+ return this.bwUtilization;
+ }
+
+ @Override
+ public double packetLossRate() {
+ return this.packetLossRatio;
+ }
+
+ @Override
+ public Duration flowDelay() {
+ return this.flowDelay;
+ }
+
+
+ @Override
+ public List<String> alarms() {
+ return this.alarms;
+ }
+
+ /**
+ * Builder for tunnelStatistics.
+ */
+ public static final class Builder {
+ TunnelId tunnelId;
+ double bwUtilization;
+ double packetLossRatio;
+ Duration flowDelay;
+ List<String> alarms;
+
+ public Builder() {
+
+ }
+
+ /**
+ * Set tunnel id.
+ *
+ * @param tunnelId tunnel id
+ * @return builder object
+ */
+ public Builder setTunnelId(TunnelId tunnelId) {
+ this.tunnelId = tunnelId;
+
+ return this;
+ }
+
+ /**
+ * set bandwidth utilization.
+ *
+ * @param bwUtilization bandwidth utilization
+ * @return builder object
+ */
+ public Builder setBwUtilization(double bwUtilization) {
+ this.bwUtilization = bwUtilization;
+
+ return this;
+ }
+
+ /**
+ * Set packet loss ratio.
+ *
+ * @param packetLossRatio packet loss ratio
+ * @return builder object
+ */
+ public Builder setPacketLossRatio(double packetLossRatio) {
+ this.packetLossRatio = packetLossRatio;
+
+ return this;
+ }
+
+ /**
+ * Set flow delay.
+ *
+ * @param flowDelay flow delay
+ * @return builder object
+ */
+ public Builder setFlowDelay(Duration flowDelay) {
+ this.flowDelay = flowDelay;
+
+ return this;
+ }
+
+ /**
+ * Set alarms.
+ *
+ * @param alarms alarms of a tunnel
+ * @return builder object
+ */
+ public Builder setAlarms(List<String> alarms) {
+ this.alarms = alarms;
+
+ return this;
+ }
+
+ /**
+ * Creates a TunnelStatistics object.
+ *
+ * @return DefaultTunnelStatistics
+ */
+ public DefaultTunnelStatistics build() {
+ return new DefaultTunnelStatistics(tunnelId,
+ bwUtilization,
+ packetLossRatio,
+ flowDelay,
+ alarms);
+ }
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/DomainTunnelId.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/DomainTunnelId.java
new file mode 100644
index 0000000..77e14fb
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/DomainTunnelId.java
@@ -0,0 +1,66 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import org.onlab.util.Identifier;
+
+/**
+ * A wrapper class for a long used to identify domain level tunnels.
+ */
+public final class DomainTunnelId extends Identifier<Long> {
+
+ /**
+ * Creates a tunnel identifier from the specified tunnel.
+ *
+ * @param value long value
+ * @return domain tunnel identifier
+ */
+ public static DomainTunnelId valueOf(long value) {
+ return new DomainTunnelId(value);
+ }
+
+ /**
+ * Creates a tunnel identifier from the specified tunnel.
+ *
+ * @param value long value as a string
+ * @return domain tunnel identifier
+ */
+ public static DomainTunnelId valueOf(String value) {
+ return new DomainTunnelId(Long.parseLong(value));
+ }
+
+ /**
+ * Constructor for serializer.
+ */
+ protected DomainTunnelId() {
+ super(0L);
+ }
+
+ /**
+ * Constructs the Domain ID corresponding to a given long value.
+ *
+ * @param value the underlying value of this domain ID
+ */
+ public DomainTunnelId(long value) {
+ super(value);
+ }
+
+ @Override
+ public String toString() {
+ return "0x" + Long.toHexString(identifier);
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/IpTunnelEndPoint.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/IpTunnelEndPoint.java
new file mode 100644
index 0000000..c9f8ddf
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/IpTunnelEndPoint.java
@@ -0,0 +1,80 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import java.util.Objects;
+
+import com.google.common.annotations.Beta;
+import org.onlab.packet.IpAddress;
+
+import com.google.common.base.MoreObjects;
+
+/**
+ * Represent for a tunnel point using ip address.
+ */
+@Beta
+public final class IpTunnelEndPoint implements TunnelEndPoint {
+
+ private final IpAddress ip;
+
+ /**
+ * Public construction is prohibited.
+ * @param ip ip address
+ */
+ private IpTunnelEndPoint(IpAddress ip) {
+ this.ip = ip;
+ }
+
+ /**
+ * Create a IP tunnel end point.
+ * @param ip IP address
+ * @return IpTunnelEndPoint
+ */
+ public static IpTunnelEndPoint ipTunnelPoint(IpAddress ip) {
+ return new IpTunnelEndPoint(ip);
+ }
+
+ /**
+ * Returns IP address.
+ * @return IP address
+ */
+ public IpAddress ip() {
+ return ip;
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(ip);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (obj instanceof IpTunnelEndPoint) {
+ final IpTunnelEndPoint other = (IpTunnelEndPoint) obj;
+ return Objects.equals(this.ip, other.ip);
+ }
+ return false;
+ }
+
+ @Override
+ public String toString() {
+ return MoreObjects.toStringHelper(getClass()).add("ip", ip).toString();
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/LabelStack.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/LabelStack.java
new file mode 100644
index 0000000..7976218
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/LabelStack.java
@@ -0,0 +1,34 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import org.onosproject.incubator.net.resource.label.LabelResourceId;
+import org.onosproject.net.NetworkResource;
+
+import java.util.List;
+
+/**
+ * Representation of a label stack in a network which represents the network path.
+ */
+public interface LabelStack extends NetworkResource {
+
+ /**
+ * Returns sequence of label resources comprising the path.
+ *
+ * @return list of links
+ */
+ List<LabelResourceId> labelResources();
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/NetworkTunnelId.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/NetworkTunnelId.java
new file mode 100644
index 0000000..868804e
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/NetworkTunnelId.java
@@ -0,0 +1,61 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import com.google.common.annotations.Beta;
+import org.onlab.util.Identifier;
+
+/**
+ * Representation of a Network Tunnel Id.
+ */
+@Beta
+public final class NetworkTunnelId extends Identifier<Long> {
+ /**
+ * Creates an tunnel identifier from the specified tunnel.
+ *
+ * @param value long value
+ * @return tunnel identifier
+ */
+ public static NetworkTunnelId valueOf(long value) {
+ return new NetworkTunnelId(value);
+ }
+
+ public static NetworkTunnelId valueOf(String value) {
+ return new NetworkTunnelId(Long.parseLong(value));
+ }
+
+ /**
+ * Constructor for serializer.
+ */
+ NetworkTunnelId() {
+ super(0L);
+ }
+
+ /**
+ * Constructs the ID corresponding to a given long value.
+ *
+ * @param value the underlying value of this ID
+ */
+ public NetworkTunnelId(long value) {
+ super(value);
+ }
+
+ @Override
+ public String toString() {
+ return "0x" + Long.toHexString(identifier);
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/OpticalLogicId.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/OpticalLogicId.java
new file mode 100644
index 0000000..86e9321
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/OpticalLogicId.java
@@ -0,0 +1,59 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import com.google.common.annotations.Beta;
+import com.google.common.primitives.UnsignedLongs;
+import org.onlab.util.Identifier;
+
+/**
+ * Representation of a label Id, a logical port identifier.
+ */
+@Beta
+public final class OpticalLogicId extends Identifier<Long> {
+
+ /**
+ * Constructor, public creation is prohibited.
+ */
+ private OpticalLogicId(long id) {
+ super(id);
+ }
+
+ /**
+ * Returns the LabelId representing the specified long value.
+ *
+ * @param id identifier as long value
+ * @return LabelId
+ */
+ public static OpticalLogicId logicId(long id) {
+ return new OpticalLogicId(id);
+ }
+
+ /**
+ * Returns the LabelId representing the specified string value.
+ *
+ * @param string identifier as string value
+ * @return LabelId
+ */
+ public static OpticalLogicId logicId(String string) {
+ return new OpticalLogicId(UnsignedLongs.decode(string));
+ }
+
+ public long toLong() {
+ return identifier;
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/OpticalTunnelEndPoint.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/OpticalTunnelEndPoint.java
new file mode 100644
index 0000000..0dccd35
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/OpticalTunnelEndPoint.java
@@ -0,0 +1,90 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import java.util.Optional;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.net.Annotated;
+import org.onosproject.net.ElementId;
+import org.onosproject.net.NetworkResource;
+import org.onosproject.net.PortNumber;
+import org.onosproject.net.Provided;
+
+/**
+ * Generic representation of a logical port entity in a consistent way,
+ * it is used to identify e.g., ODUk timeSlot, WDM lambda, etc.
+ * It supports nested case.
+ */
+@Beta
+public interface OpticalTunnelEndPoint extends TunnelEndPoint, Annotated, Provided, NetworkResource {
+
+ /** Represents coarse tunnel point type classification. */
+ public enum Type {
+ /**
+ * Signifies optical data unit-based tunnel point.
+ */
+ TIMESLOT,
+
+ /**
+ * Signifies optical wavelength-based tunnel point.
+ */
+ LAMBDA
+ }
+
+ /**
+ * Returns the identifier.
+ *
+ * @return identifier
+ */
+ OpticalLogicId id();
+
+ /**
+ * Returns the parent network element to which this tunnel point belongs.
+ *
+ * @return parent network element
+ */
+ Optional<ElementId> elementId();
+
+ /**
+ * Returns the parent network port to which this tunnel point belongs, can not be be null.
+ *
+ * @return port number
+ */
+ Optional<PortNumber> portNumber();
+
+ /**
+ * Returns the parent tunnel point to which this tunnel point belongs, optional.
+ *
+ * @return parent tunnel point, if it is null, the parent is a physical port
+ */
+ Optional<OpticalTunnelEndPoint> parentPoint();
+
+ /**
+ * Indicates whether or not the port is global significant.
+ *
+ * @return true if the port is global significant
+ */
+ boolean isGlobal();
+
+ /**
+ * Returns the tunnel point type.
+ *
+ * @return tunnel point type
+ */
+ Type type();
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/Tunnel.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/Tunnel.java
new file mode 100644
index 0000000..603f27a
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/Tunnel.java
@@ -0,0 +1,170 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.core.GroupId;
+import org.onosproject.net.Annotated;
+import org.onosproject.net.NetworkResource;
+import org.onosproject.net.Path;
+import org.onosproject.net.Provided;
+
+/**
+ * Abstraction of a generalized Tunnel entity (bandwidth pipe) for either L3/L2
+ * networks or L1/L0 networks, representation of e.g., VLAN, GRE tunnel, MPLS
+ * LSP, L1 ODUk connection, WDM OCH, etc.. Each Tunnel is associated with at
+ * least two tunnel end point objects that model the logical ports essentially.
+ * Note that it supports nested case.
+ */
+@Beta
+public interface Tunnel extends Annotated, Provided, NetworkResource {
+
+ /**
+ * Tunnel technology type.
+ */
+ enum Type {
+ /**
+ * Signifies that this is a MPLS tunnel.
+ */
+ MPLS,
+ /**
+ * Signifies that this is a L2 tunnel.
+ */
+ VLAN,
+ /**
+ * Signifies that this is a DC L2 extension tunnel.
+ */
+ VXLAN,
+ /**
+ * Signifies that this is a L3 tunnel.
+ */
+ GRE,
+ /**
+ * Signifies that this is a L1 OTN tunnel.
+ */
+ ODUK,
+ /**
+ * Signifies that this is a L0 OCH tunnel.
+ */
+ OCH
+ }
+
+ /**
+ * Representation of the tunnel state.
+ */
+ public enum State {
+ /**
+ * Signifies that a tunnel is currently in a initialized state.
+ */
+ INIT,
+ /**
+ * Signifies that a tunnel is currently established but no traffic.
+ */
+ ESTABLISHED,
+ /**
+ * Signifies that a tunnel is currently active. This state means that
+ * this tunnel is available. It can be borrowed by consumer.
+ */
+ ACTIVE,
+ /**
+ * Signifies that a tunnel is currently out of service.
+ */
+ FAILED,
+ /**
+ * Signifies that a tunnel is currently inactive. This state means that
+ * this tunnel can not be borrowed by consumer.
+ */
+ INACTIVE,
+
+ /**
+ * Signifies that the tunnel's state is unreliable and should be setup again.
+ */
+ UNSTABLE,
+
+ /**
+ * Signifies that a tunnel is being established.
+ */
+ ESTABLISHING,
+
+ /**
+ * Signifies that a tunnel is being removed.
+ */
+ REMOVING
+ }
+
+ /**
+ * Returns the tunnel state.
+ *
+ * @return tunnel state
+ */
+ State state();
+
+ /**
+ * the origin of a tunnel.
+ *
+ * @return the origin of a tunnel
+ */
+ TunnelEndPoint src();
+
+ /**
+ * the terminal of a tunnel.
+ *
+ * @return the terminal of a tunnel
+ */
+ TunnelEndPoint dst();
+
+ /**
+ * Returns the tunnel type.
+ *
+ * @return tunnel type
+ */
+ Type type();
+
+ /**
+ * Returns group flow table id which a tunnel match up.
+ *
+ * @return OpenFlowGroupId
+ */
+ GroupId groupId();
+
+ /**
+ * Returns tunnel identify generated by ONOS as primary key.
+ *
+ * @return TunnelId
+ */
+ TunnelId tunnelId();
+
+ /**
+ * Return the name of a tunnel.
+ *
+ * @return Tunnel Name
+ */
+ TunnelName tunnelName();
+
+ /**
+ * Network resource backing the tunnel, e.g. lambda, VLAN id, MPLS tag.
+ *
+ * @return backing resource
+ */
+ NetworkResource resource();
+
+ /**
+ * Returns the path of the tunnel.
+ *
+ * @return the path of the tunnel
+ */
+ Path path();
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelAdminService.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelAdminService.java
new file mode 100644
index 0000000..12246a5
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelAdminService.java
@@ -0,0 +1,72 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.net.Path;
+import org.onosproject.net.provider.ProviderId;
+
+/**
+ * Service for administering the inventory of provisioned tunnels.
+ */
+@Beta
+public interface TunnelAdminService {
+
+ /**
+ * Removes the provisioned tunnel.
+ *
+ * @param tunnelId tunnel ID
+ */
+ void removeTunnel(TunnelId tunnelId);
+
+ /**
+ * Removes the provisioned tunnel leading to and from the
+ * specified labels.
+ *
+ * @param src source label
+ * @param dst destination label
+ * @param producerName producer name
+ */
+ void removeTunnels(TunnelEndPoint src, TunnelEndPoint dst, ProviderId producerName);
+
+ /**
+ * Removes all provisioned tunnels leading to and from the
+ * specified connection point.
+ *
+ * @param src source connection point
+ * @param dst destination connection point
+ * @param type tunnel type
+ * @param producerName producer name
+ */
+ void removeTunnels(TunnelEndPoint src, TunnelEndPoint dst, Tunnel.Type type, ProviderId producerName);
+
+ /**
+ * Invokes the core to update a tunnel based on specified tunnel parameters.
+ *
+ * @param tunnel Tunnel
+ * @param path explicit route (path changed) or null (path not changed) for the tunnel
+ */
+ void updateTunnel(Tunnel tunnel, Path path);
+
+ /**
+ * Updates the state of a tunnel.
+ *
+ * @param tunnel tunnel to be changed
+ * @param state new state of the tunnel
+ */
+ void updateTunnelState(Tunnel tunnel, Tunnel.State state);
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelDescription.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelDescription.java
new file mode 100644
index 0000000..0444c38
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelDescription.java
@@ -0,0 +1,95 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.core.GroupId;
+import org.onosproject.incubator.net.tunnel.Tunnel.Type;
+import org.onosproject.net.Annotated;
+import org.onosproject.net.Description;
+import org.onosproject.net.NetworkResource;
+import org.onosproject.net.Path;
+import org.onosproject.net.provider.ProviderId;
+
+/**
+ * Describes a tunnel.
+ */
+@Beta
+public interface TunnelDescription extends Description, Annotated {
+
+ /**
+ * Returns the tunnel id.
+ *
+ * @return tunnelId
+ */
+ TunnelId id();
+
+ /**
+ * Returns the connection point source.
+ *
+ * @return tunnel source ConnectionPoint
+ */
+ TunnelEndPoint src();
+
+ /**
+ * Returns the connection point destination.
+ *
+ * @return tunnel destination
+ */
+ TunnelEndPoint dst();
+
+ /**
+ * Returns the tunnel type.
+ *
+ * @return tunnel type
+ */
+ Type type();
+
+ /**
+ * Returns group flow table id which a tunnel match up.
+ *
+ * @return OpenFlowGroupId
+ */
+ GroupId groupId();
+
+ /**
+ * Returns tunnel producer name.
+ *
+ * @return producer name
+ */
+ ProviderId producerName();
+
+ /**
+ * Return the name of a tunnel.
+ *
+ * @return Tunnel Name
+ */
+ TunnelName tunnelName();
+
+ /**
+ * Returns the path of the tunnel.
+ *
+ * @return the path of the tunnel
+ */
+ Path path();
+
+ /**
+ * Returns the network resource backing the tunnel, e.g. lambda, VLAN id, MPLS tag, label stack.
+ *
+ * @return backing resource
+ */
+ NetworkResource resource();
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelEndPoint.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelEndPoint.java
new file mode 100644
index 0000000..4d6fe68
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelEndPoint.java
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import com.google.common.annotations.Beta;
+
+/**
+ * Represents for source end point or destination end point of a tunnel. Maybe a tunnel
+ * based on ConnectPoint, IpAddress, MacAddress and so on is built.
+ */
+@Beta
+public interface TunnelEndPoint {
+
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelEndPointFormatter.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelEndPointFormatter.java
new file mode 100644
index 0000000..ac1cd07
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelEndPointFormatter.java
@@ -0,0 +1,61 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+
+import com.google.common.annotations.Beta;
+import org.onosproject.ui.table.CellFormatter;
+import org.onosproject.ui.table.cell.AbstractCellFormatter;
+
+import java.util.Optional;
+
+/**
+ * Formats an optical tunnel endpoint as "(type)/(element-id)/(port)".
+ * Formats an IP tunnel endpoint as "ip".
+ */
+@Beta
+public final class TunnelEndPointFormatter extends AbstractCellFormatter {
+ //non-instantiable
+ private TunnelEndPointFormatter() {
+ }
+
+ private String safeOptional(Optional<?> optional) {
+ return optional.isPresent() ? optional.get().toString() : QUERY;
+ }
+
+ @Override
+ protected String nonNullFormat(Object value) {
+
+ if (value instanceof DefaultOpticalTunnelEndPoint) {
+ DefaultOpticalTunnelEndPoint ep =
+ (DefaultOpticalTunnelEndPoint) value;
+
+ String e = safeOptional(ep.elementId());
+ String p = safeOptional(ep.portNumber());
+ return ep.type() + SLASH + e + SLASH + p;
+
+ } else if (value instanceof IpTunnelEndPoint) {
+ IpTunnelEndPoint cp = (IpTunnelEndPoint) value;
+ return cp.ip().toString();
+ }
+ return EMPTY;
+ }
+
+ /**
+ * An instance of this class.
+ */
+ public static final CellFormatter INSTANCE = new TunnelEndPointFormatter();
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelEvent.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelEvent.java
new file mode 100644
index 0000000..5d97ba8
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelEvent.java
@@ -0,0 +1,70 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.event.AbstractEvent;
+
+/**
+ * Describes tunnel events.
+ */
+@Beta
+public final class TunnelEvent extends AbstractEvent<TunnelEvent.Type, Tunnel> {
+
+ /**
+ * Type of tunnel events.
+ */
+ public enum Type {
+ /**
+ * Signifies that a new tunnel has been added.
+ */
+ TUNNEL_ADDED,
+
+ /**
+ * Signifies that a tunnel has been updated or changed state.
+ */
+ TUNNEL_UPDATED,
+
+ /**
+ * Signifies that a tunnel has been removed.
+ */
+ TUNNEL_REMOVED
+ }
+
+ /**
+ * Creates an event of a given type and for the specified tunnel.
+ *
+ * @param type tunnel event type
+ * @param tunnel event tunnel subject
+ */
+ public TunnelEvent(Type type, Tunnel tunnel) {
+ super(type, tunnel);
+ }
+
+ /**
+ * Creates an event of a given type and for the specified link and
+ * the current time.
+ *
+ * @param type tunnel event type
+ * @param tunnel event tunnel subject
+ * @param time occurrence time
+ */
+ public TunnelEvent(Type type, Tunnel tunnel, long time) {
+ super(type, tunnel, time);
+ }
+
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelId.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelId.java
new file mode 100644
index 0000000..a28b53c
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelId.java
@@ -0,0 +1,57 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import com.google.common.annotations.Beta;
+import org.onlab.util.Identifier;
+
+/**
+ * Representation of a Tunnel Id.
+ */
+@Beta
+public final class TunnelId extends Identifier<String> {
+ /**
+ * Creates an tunnel identifier from the specified tunnel.
+ *
+ * @param value string value
+ * @return tunnel identifier
+ */
+ public static TunnelId valueOf(String value) {
+ return new TunnelId(value);
+ }
+
+ /**
+ * Constructor for serializer.
+ */
+ TunnelId() {
+ super("0");
+ }
+
+ /**
+ * Constructs the ID corresponding to a given string value.
+ *
+ * @param value the underlying value of this ID
+ */
+ TunnelId(String value) {
+ super(value);
+ }
+
+ @Override
+ public String toString() {
+ return id();
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelListener.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelListener.java
new file mode 100644
index 0000000..3394dfd
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelListener.java
@@ -0,0 +1,27 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.event.EventListener;
+
+/**
+ * Entity capable of receiving tunnel related events.
+ */
+@Beta
+public interface TunnelListener extends EventListener<TunnelEvent> {
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelName.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelName.java
new file mode 100644
index 0000000..f15d47b
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelName.java
@@ -0,0 +1,79 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import com.google.common.annotations.Beta;
+
+import java.util.Objects;
+
+/**
+ * Represents for a unique tunnel name. TunnelId is generated by ONOS while
+ * TunnelName is given by producer. The consumer can borrow tunnels with
+ * TunnelId or TunnelName.
+ */
+@Beta
+public final class TunnelName {
+ private final String str;
+
+ // Default constructor for serialization
+ private TunnelName(String tunnelName) {
+ this.str = tunnelName;
+ }
+
+
+ /**
+ * Creates a tunnel name using the supplied URI string.
+ *
+ * @param tunnelName tunnel name string
+ * @return tunnel name object
+ */
+ public static TunnelName tunnelName(String tunnelName) {
+ return new TunnelName(tunnelName);
+ }
+
+ /**
+ * The string of tunnel name.
+ *
+ * @return the string of tunnel name
+ */
+ public String value() {
+ return str;
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(str);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (obj instanceof TunnelName) {
+ final TunnelName that = (TunnelName) obj;
+ return this.getClass() == that.getClass()
+ && Objects.equals(this.str, that.str);
+ }
+ return false;
+ }
+
+ @Override
+ public String toString() {
+ return str;
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelProvider.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelProvider.java
new file mode 100644
index 0000000..05d2783
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelProvider.java
@@ -0,0 +1,115 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.net.ElementId;
+import org.onosproject.net.Path;
+import org.onosproject.net.provider.Provider;
+
+/**
+ * Abstraction of an entity providing tunnel setup/release services to the core.
+ */
+@Beta
+public interface TunnelProvider extends Provider {
+
+ /**
+ * Instructs the provider to setup a tunnel. It's used by consumers.
+ *
+ * @param tunnel Tunnel
+ * @param path explicit route or null for the tunnel
+ */
+ void setupTunnel(Tunnel tunnel, Path path);
+
+ /**
+ * Instructs the provider to setup a tunnel given the respective device.
+ * It's used by consumers.
+ *
+ * @param srcElement device
+ * @param tunnel Tunnel
+ * @param path explicit route (not null) for the tunnel
+ */
+ void setupTunnel(ElementId srcElement, Tunnel tunnel, Path path);
+
+ /**
+ * Instructs the provider to release a tunnel. It's used by consumers.
+ *
+ * @param tunnel Tunnel
+ */
+ void releaseTunnel(Tunnel tunnel);
+
+ /**
+ * Instructs the provider to release a tunnel given the respective device.
+ * It's used by consumers.
+ *
+ * @param srcElement device
+ * @param tunnel Tunnel
+ */
+ void releaseTunnel(ElementId srcElement, Tunnel tunnel);
+
+ /**
+ * Instructs the provider to update a tunnel. It's used by consumers. Maybe
+ * some consumers enable to update a tunnel.
+ *
+ * @param tunnel Tunnel
+ * @param path explicit route (path changed) or null (path not changed) for
+ * the tunnel
+ */
+ void updateTunnel(Tunnel tunnel, Path path);
+
+ /**
+ * Instructs the provider to update a tunnel given the respective device.
+ * It's used by consumers. Maybe some consumers enable to update a tunnel.
+ *
+ * @param srcElement device
+ * @param tunnel Tunnel
+ * @param path explicit route (path changed) or null (path not changed) for
+ * the tunnel
+ */
+ void updateTunnel(ElementId srcElement, Tunnel tunnel, Path path);
+
+ /**
+ * Signals that the provider has added a tunnel. It's used by producers.
+ *
+ * @param tunnel tunnel information
+ * @return tunnel identity
+ */
+ TunnelId tunnelAdded(TunnelDescription tunnel);
+
+ /**
+ * Signals that the provider has removed a tunnel. It's used by producers.
+ *
+ * @param tunnel tunnel information
+ */
+ void tunnelRemoved(TunnelDescription tunnel);
+
+ /**
+ * Signals that the a tunnel was changed (e.g., sensing changes of
+ * tunnel).It's used by producers.
+ *
+ * @param tunnel tunnel information
+ */
+ void tunnelUpdated(TunnelDescription tunnel);
+
+ /**
+ * Signals that the a tunnel was queried.
+ * It's used by producers.
+ * @param tunnelId tunnel identity
+ * @return tunnel entity
+ */
+ Tunnel tunnelQueryById(TunnelId tunnelId);
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelProviderRegistry.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelProviderRegistry.java
new file mode 100644
index 0000000..740e257
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelProviderRegistry.java
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.net.provider.ProviderRegistry;
+
+/**
+ * Abstraction of an tunnel provider registry.
+ */
+@Beta
+public interface TunnelProviderRegistry
+ extends ProviderRegistry<TunnelProvider, TunnelProviderService> {
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelProviderService.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelProviderService.java
new file mode 100644
index 0000000..3dcdd29
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelProviderService.java
@@ -0,0 +1,78 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import com.google.common.annotations.Beta;
+
+import org.onosproject.incubator.net.tunnel.Tunnel.State;
+import org.onosproject.net.provider.ProviderService;
+
+/**
+ * APIs for tunnel provider to notify the tunnel subSystem.
+ */
+@Beta
+public interface TunnelProviderService extends ProviderService<TunnelProvider> {
+
+ /**
+ * Signals that the provider has added a tunnel.
+ *
+ * @param tunnel tunnel information
+ * @return tunnel identity
+ */
+ TunnelId tunnelAdded(TunnelDescription tunnel);
+
+ /**
+ * Signals that the provider has added a tunnel with a status which may not
+ * be default, hence is provided as an input.
+ *
+ * @param tunnel tunnel information
+ * @param state tunnel working status
+ * @return tunnel identity
+ */
+ TunnelId tunnelAdded(TunnelDescription tunnel, State state);
+
+ /**
+ * Signals that the provider has removed a tunnel.
+ *
+ * @param tunnel tunnel information
+ */
+ void tunnelRemoved(TunnelDescription tunnel);
+
+ /**
+ * Signals that the a tunnel was changed (e.g., sensing changes of tunnel).
+ *
+ * @param tunnel tunnel information
+ */
+ void tunnelUpdated(TunnelDescription tunnel);
+
+ /**
+ * Signals that the tunnel was changed with tunnel status change.
+ *
+ * @param tunnel tunnel information
+ * @param state tunnel working status
+ */
+ void tunnelUpdated(TunnelDescription tunnel, State state);
+
+ /**
+ * Signals that the a tunnel was queried.
+ *
+ * @param tunnelId tunnel identity
+ * @return tunnel entity
+ */
+ Tunnel tunnelQueryById(TunnelId tunnelId);
+
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelService.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelService.java
new file mode 100644
index 0000000..cee6310
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelService.java
@@ -0,0 +1,224 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import java.util.Collection;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.event.ListenerService;
+import org.onosproject.incubator.net.tunnel.Tunnel.Type;
+import org.onosproject.net.Annotations;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.ElementId;
+import org.onosproject.net.Path;
+
+/**
+ * Service for interacting with the inventory of tunnels.
+ */
+@Beta
+public interface TunnelService
+ extends ListenerService<TunnelEvent, TunnelListener> {
+
+ /**
+ * Borrows a specific tunnel. Annotations parameter is reserved.If there
+ * is no tunnel in the store, returns a "null" object, and record the tunnel subscription.
+ * Where tunnel is created, ONOS notifies this consumer actively.
+ *
+ * @param consumerId a tunnel consumer
+ * @param tunnelId tunnel identify generated by onos
+ * @param annotations Annotations
+ * @return Tunnel subscribed tunnel
+ */
+ Tunnel borrowTunnel(ApplicationId consumerId, TunnelId tunnelId,
+ Annotations... annotations);
+
+ /**
+ * Borrows a specific tunnel by tunnelName. Annotations parameter is reserved.If there
+ * is no tunnel in the store, return a "null" object, and record the tunnel subscription.
+ * Where tunnel is created, ONOS notifies this consumer actively.
+ *
+ * @param consumerId a tunnel consumer
+ * @param tunnelName tunnel name
+ * @param annotations Annotations
+ * @return collection of subscribed Tunnels
+ */
+ Collection<Tunnel> borrowTunnel(ApplicationId consumerId, TunnelName tunnelName,
+ Annotations... annotations);
+
+ /**
+ * Borrows all tunnels between source and destination. Annotations
+ * parameter is reserved.If there is no any tunnel in the store, return a
+ * empty collection,and record the tunnel subscription. Where tunnel is created, ONOS
+ * notifies this consumer actively. Otherwise ONOS core returns all the
+ * tunnels, consumer determined which one to use.
+ *
+ * @param consumerId a tunnel consumer
+ * @param src a source point of tunnel.
+ * @param dst a destination point of tunnel
+ * @param annotations Annotations
+ * @return collection of subscribed Tunnels
+ */
+ Collection<Tunnel> borrowTunnel(ApplicationId consumerId, TunnelEndPoint src,
+ TunnelEndPoint dst, Annotations... annotations);
+
+ /**
+ * Borrows all specified type tunnels between source and destination.
+ * Annotations parameter is reserved.If there is no any tunnel in the store,
+ * return a empty collection, and record the tunnel subscription. Where tunnel is
+ * created, ONOS notifies this consumer actively. Otherwise,ONOS core returns
+ * all available tunnels, consumer determined which one to use.
+ *
+ * @param consumerId a tunnel consumer
+ * @param src a source point of tunnel.
+ * @param dst a destination point of tunnel
+ * @param type tunnel type
+ * @param annotations Annotations
+ * @return collection of available Tunnels
+ */
+ Collection<Tunnel> borrowTunnel(ApplicationId consumerId, TunnelEndPoint src,
+ TunnelEndPoint dst, Type type,
+ Annotations... annotations);
+
+ /**
+ * Creates a tunnel with given path and default initial state. The state changes
+ * in due course of time based on changes happening in the network.
+ *
+ * @param producerId a tunnel producer
+ * @param srcElementId element id of the source
+ * @param tunnel to be created
+ * @param path path of the tunnel
+ * @return generated tunnel identity
+ */
+ TunnelId setupTunnel(ApplicationId producerId, ElementId srcElementId, Tunnel tunnel, Path path);
+
+ /**
+ * Triggers removal of specified tunnel.
+ *
+ * @param producerId a tunnel producer
+ * @param tunnelId identity for the tunnel to be triggered for removal
+ * @return success or failure
+ */
+ boolean downTunnel(ApplicationId producerId, TunnelId tunnelId);
+
+ /**
+ * Returns back a specific tunnel to store.
+ *
+ * @param consumerId a tunnel consumer
+ * @param tunnelId tunnel identify generated by ONOS
+ * @param annotations Annotations
+ * @return success or fail
+ */
+ boolean returnTunnel(ApplicationId consumerId, TunnelId tunnelId,
+ Annotations... annotations);
+
+ /**
+ * Returns all specific name tunnel back store. Annotations parameter is reserved.if there
+ * is no tunnel in the store, return a "null" object, and record the tunnel subscription.
+ * Where tunnel is created, ONOS notifies this consumer actively.
+ *
+ * @param consumerId a tunnel consumer
+ * @param tunnelName tunnel name
+ * @param annotations Annotations
+ * @return boolean
+ */
+ boolean returnTunnel(ApplicationId consumerId, TunnelName tunnelName,
+ Annotations... annotations);
+
+ /**
+ * Returns all specific type tunnels between source and destination back
+ * store. Annotations parameter is reserved.
+ *
+ * @param consumerId a tunnel consumer
+ * @param src a source point of tunnel.
+ * @param dst a destination point of tunnel
+ * @param type tunnel type
+ * @param annotations Annotations
+ * @return success or fail
+ */
+ boolean returnTunnel(ApplicationId consumerId, TunnelEndPoint src,
+ TunnelEndPoint dst, Type type,
+ Annotations... annotations);
+
+ /**
+ * Returns all tunnels between source and destination back the store.
+ * Annotations parameter is reserved.
+ *
+ * @param consumerId a tunnel consumer
+ * @param src a source point of tunnel.
+ * @param dst a destination point of tunnel.
+ * @param annotations Annotations
+ * @return success or fail
+ */
+ boolean returnTunnel(ApplicationId consumerId, TunnelEndPoint src,
+ TunnelEndPoint dst, Annotations... annotations);
+
+ /**
+ * Returns a tunnel by a specific tunnel identity.
+ *
+ * @param tunnelId tunnel identify generated by tunnel producer
+ * @return Tunnel
+ */
+ Tunnel queryTunnel(TunnelId tunnelId);
+
+ /**
+ * Returns all tunnel subscription record by consumer.
+ *
+ * @param consumerId consumer identity
+ * @return Collection of TunnelSubscription
+ */
+ Collection<TunnelSubscription> queryTunnelSubscription(ApplicationId consumerId);
+
+ /**
+ * Returns all specified type tunnels.
+ *
+ * @param type tunnel type
+ * @return Collection of tunnels
+ */
+ Collection<Tunnel> queryTunnel(Type type);
+
+ /**
+ * Returns all tunnels between source point and destination point.
+ *
+ * @param src a source point of tunnel.
+ * @param dst a destination point of tunnel.
+ * @return Collection of tunnels
+ */
+ Collection<Tunnel> queryTunnel(TunnelEndPoint src, TunnelEndPoint dst);
+
+ /**
+ * Returns all tunnels.
+ *
+ * @return Collection of tunnels
+ */
+ Collection<Tunnel> queryAllTunnels();
+
+ /**
+ * Returns all tunnels.
+ *
+ * @return all tunnels
+ */
+ int tunnelCount();
+
+ /**
+ * Returns the collection of tunnels applied on the specified device.
+ *
+ * @param deviceId device identifier
+ * @return collection of tunnels
+ */
+ Iterable<Tunnel> getTunnels(DeviceId deviceId);
+
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelStatistics.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelStatistics.java
new file mode 100644
index 0000000..d260d26
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelStatistics.java
@@ -0,0 +1,64 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import com.google.common.annotations.Beta;
+
+import java.time.Duration;
+import java.util.List;
+
+/**
+ * Statistics of a tunnel.
+ */
+@Beta
+public interface TunnelStatistics {
+
+ /**
+ * Returns the tunnel id.
+ *
+ * @return tunnelId id of tunnel
+ */
+ TunnelId id();
+
+ /**
+ * Returns the bandwidth utilization of a tunnel.
+ *
+ * @return bandwidth utilization
+ */
+ double bandwidthUtilization();
+
+ /**
+ * Returns the packet loss ratio of a tunnel.
+ *
+ * @return tunnel packet loss ratio
+ */
+ double packetLossRate();
+
+ /**
+ * Returns the end-to-end traffic flow delay of a tunnel.
+ *
+ * @return tunnel flow delay
+ */
+ Duration flowDelay();
+
+ /**
+ * Returns the alarms on a tunnel.
+ *
+ * @return tunnel alarms
+ */
+ List<String> alarms();
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelStore.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelStore.java
new file mode 100644
index 0000000..b4f4a8c
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelStore.java
@@ -0,0 +1,239 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import java.util.Collection;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.incubator.net.tunnel.Tunnel.State;
+import org.onosproject.incubator.net.tunnel.Tunnel.Type;
+import org.onosproject.net.Annotations;
+import org.onosproject.net.provider.ProviderId;
+import org.onosproject.store.Store;
+
+/**
+ * Manages inventory of tunnel; not intended for direct use.
+ */
+@Beta
+public interface TunnelStore extends Store<TunnelEvent, TunnelStoreDelegate> {
+ /**
+ * Creates or updates a tunnel.
+ *
+ * @param tunnel tunnel
+ * @return tunnel identity
+ */
+ TunnelId createOrUpdateTunnel(Tunnel tunnel);
+
+ /**
+ * Creates a tunnel or updates a tunnel with the new state given in input.
+ *
+ * @param tunnel tunnel
+ * @param state tunnel state
+ * @return tunnel identity
+ */
+ TunnelId createOrUpdateTunnel(Tunnel tunnel, State state);
+
+ /**
+ * Deletes a tunnel by a specific tunnel identifier.
+ *
+ * @param tunnelId tunnel unique identifier generated by ONOS
+ */
+ void deleteTunnel(TunnelId tunnelId);
+
+ /**
+ * Deletes all tunnels between source point and destination point.
+ *
+ * @param src a source point of tunnel.
+ * @param dst a destination point of tunnel.
+ * @param producerName producerName
+ */
+ void deleteTunnel(TunnelEndPoint src, TunnelEndPoint dst,
+ ProviderId producerName);
+
+ /**
+ * Deletes all specific type tunnels between source point and destination
+ * point.
+ *
+ * @param src a source point of tunnel.
+ * @param dst a destination point of tunnel.
+ * @param type tunnel type
+ * @param producerName producerName
+ */
+ void deleteTunnel(TunnelEndPoint src, TunnelEndPoint dst,
+ Tunnel.Type type, ProviderId producerName);
+
+ /**
+ * Returns a specific tunnel. Annotations parameter is reserved. If there
+ * is no tunnel in the store, return a "null" object, and record the tunnel subscription.
+ * Where tunnel is created, ONOS notifies this consumer actively.
+ *
+ * @param consumerId a tunnel consumer
+ * @param tunnelId tunnel identify generated by onos
+ * @param annotations parameter
+ * @return Tunnel subscribed tunnel
+ */
+ Tunnel borrowTunnel(ApplicationId consumerId, TunnelId tunnelId,
+ Annotations... annotations);
+
+ /**
+ * Returns a specific tunnel by tunnelName. Annotations parameter is
+ * reserved. If there is no tunnel in the store, return a "null" object,and
+ * record the tunnel subscription. Where tunnel is created, ONOS notifies this consumer
+ * actively.
+ *
+ * @param consumerId a tunnel consumer
+ * @param tunnelName tunnel name
+ * @param annotations parameter
+ * @return collection of subscribed Tunnels
+ */
+ Collection<Tunnel> borrowTunnel(ApplicationId consumerId,
+ TunnelName tunnelName,
+ Annotations... annotations);
+
+ /**
+ * Returns all tunnels between source and destination. Annotations
+ * parameter is reserved. If there is no any tunnel in the store, return a
+ * empty collection, and record the tunnel subscription. Where tunnel is created, ONOS
+ * notifies this consumer actively. Otherwise ONOS core returns all the
+ * tunnels, consumer determined which one to use.
+ *
+ * @param consumerId a tunnel consumer
+ * @param src a source point of tunnel.
+ * @param dst a destination point of tunnel
+ * @param annotations parameter
+ * @return collection of subscribed Tunnels
+ */
+ Collection<Tunnel> borrowTunnel(ApplicationId consumerId, TunnelEndPoint src,
+ TunnelEndPoint dst, Annotations... annotations);
+
+ /**
+ * Returns all specified type tunnels between source and destination.
+ * Annotations parameter is reserved. If there is no any tunnel in the store,
+ * return a empty collection, and record the tunnel subscription. Where tunnel is
+ * created, ONOS notifies this consumer actively. Otherwise,ONOS core returns
+ * all available tunnels, consumer determined which one to use.
+ *
+ * @param consumerId a tunnel consumer
+ * @param src a source point of tunnel.
+ * @param dst a destination point of tunnel
+ * @param type tunnel type
+ * @param annotations Annotations
+ * @return collection of available Tunnels
+ */
+ Collection<Tunnel> borrowTunnel(ApplicationId consumerId, TunnelEndPoint src,
+ TunnelEndPoint dst, Type type,
+ Annotations... annotations);
+
+ /**
+ * Returns back a specific tunnel to store.
+ *
+ * @param consumerId a tunnel consumer
+ * @param tunnelId tunnel identify generated by ONOS
+ * @param annotations Annotations
+ * @return success or fail
+ */
+ boolean returnTunnel(ApplicationId consumerId, TunnelId tunnelId,
+ Annotations... annotations);
+
+ /**
+ * Returns all specific name tunnel back store. Annotations parameter is
+ * reserved.If there is no tunnel in the store, return a "null" object,and
+ * record the tunnel subscription. Where tunnel is created, ONOS notifies this consumer
+ * actively.
+ *
+ * @param consumerId a tunnel consumer
+ * @param tunnelName tunnel name
+ * @param annotations Annotations
+ * @return boolean
+ */
+ boolean returnTunnel(ApplicationId consumerId, TunnelName tunnelName,
+ Annotations... annotations);
+
+ /**
+ * Returns all specific type tunnels between source and destination back
+ * store. Annotations parameter is reserved.
+ *
+ * @param consumerId a tunnel consumer
+ * @param src a source point of tunnel.
+ * @param dst a destination point of tunnel
+ * @param type tunnel type
+ * @param annotations Annotations
+ * @return success or fail
+ */
+ boolean returnTunnel(ApplicationId consumerId, TunnelEndPoint src,
+ TunnelEndPoint dst, Type type,
+ Annotations... annotations);
+
+ /**
+ * Returns all tunnels between source and destination back the store.
+ * Annotations parameter is reserved.
+ *
+ * @param consumerId a tunnel consumer
+ * @param src a source point of tunnel.
+ * @param dst a destination point of tunnel.
+ * @param annotations Annotations
+ * @return success or fail
+ */
+ boolean returnTunnel(ApplicationId consumerId, TunnelEndPoint src,
+ TunnelEndPoint dst, Annotations... annotations);
+
+ /**
+ * Returns a tunnel by a specific tunnel identity.
+ *
+ * @param tunnelId tunnel identify generated by tunnel producer
+ * @return Tunnel
+ */
+ Tunnel queryTunnel(TunnelId tunnelId);
+
+ /**
+ * Returns all tunnel subscription record by consumer.
+ *
+ * @param consumerId consumer identity
+ * @return Collection of TunnelSubscription
+ */
+ Collection<TunnelSubscription> queryTunnelSubscription(ApplicationId consumerId);
+
+ /**
+ * Returns all specified type tunnels.
+ *
+ * @param type tunnel type
+ * @return Collection of tunnels
+ */
+ Collection<Tunnel> queryTunnel(Type type);
+
+ /**
+ * Returns all tunnels between source point and destination point.
+ *
+ * @param src a source point of tunnel.
+ * @param dst a destination point of tunnel.
+ * @return Collection of tunnels
+ */
+ Collection<Tunnel> queryTunnel(TunnelEndPoint src, TunnelEndPoint dst);
+
+ /**
+ * Returns all tunnels.
+ *
+ * @return Collection of tunnels
+ */
+ Collection<Tunnel> queryAllTunnels();
+
+ /**
+ * Returns all tunnels.
+ * @return all tunnels
+ */
+ int tunnelCount();
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelStoreDelegate.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelStoreDelegate.java
new file mode 100644
index 0000000..e94cfaa
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelStoreDelegate.java
@@ -0,0 +1,27 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.store.StoreDelegate;
+
+/**
+ * Tunnel store delegate abstraction.
+ */
+@Beta
+public interface TunnelStoreDelegate extends StoreDelegate<TunnelEvent> {
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelSubscription.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelSubscription.java
new file mode 100644
index 0000000..b0e5384
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/TunnelSubscription.java
@@ -0,0 +1,156 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import java.util.Objects;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.net.AbstractAnnotated;
+import org.onosproject.net.Annotations;
+import org.onosproject.incubator.net.tunnel.Tunnel.Type;
+
+import com.google.common.base.MoreObjects;
+
+/**
+ * Represents for a order that consumer subscribe tunnel. ONOS maintains request
+ * information, it means ONOS knows how much resource echo consumer uses in the
+ * ONOS. Although there is no a tunnel that consumer want to use, when producer
+ * creates a new tunnel, ONOS will notify the consumers that want to use it.
+ */
+@Beta
+public final class TunnelSubscription extends AbstractAnnotated {
+ private final ApplicationId consumerId;
+ private final TunnelEndPoint src;
+ private final TunnelEndPoint dst;
+ private final Type type;
+ private final TunnelId tunnelId;
+ private final TunnelName tunnelName;
+
+ /**
+ * Creates a TunnelSubscription.
+ *
+ * @param consumerId consumer identity
+ * @param src source tunnel end point of tunnel
+ * @param dst destination tunnel end point of tunnel
+ * @param tunnelId tunnel identity
+ * @param type tunnel type
+ * @param tunnelName the name of a tunnel
+ * @param annotations parameter
+ */
+ public TunnelSubscription(ApplicationId consumerId, TunnelEndPoint src,
+ TunnelEndPoint dst, TunnelId tunnelId, Type type,
+ TunnelName tunnelName, Annotations... annotations) {
+ super(annotations);
+ checkNotNull(consumerId, "consumerId cannot be null");
+ this.consumerId = consumerId;
+ this.src = src;
+ this.dst = dst;
+ this.type = type;
+ this.tunnelId = tunnelId;
+ this.tunnelName = tunnelName;
+ }
+
+ /**
+ * Returns consumer identity.
+ *
+ * @return consumerId consumer id
+ */
+ public ApplicationId consumerId() {
+ return consumerId;
+ }
+
+ /**
+ * Returns source point of tunnel.
+ *
+ * @return source point
+ */
+ public TunnelEndPoint src() {
+ return src;
+ }
+
+ /**
+ * Returns destination point of tunnel.
+ *
+ * @return destination point
+ */
+ public TunnelEndPoint dst() {
+ return dst;
+ }
+
+ /**
+ * Returns tunnel type.
+ *
+ * @return tunnel type
+ */
+ public Type type() {
+ return type;
+ }
+
+ /**
+ * Returns tunnel identity.
+ *
+ * @return tunnel id
+ */
+ public TunnelId tunnelId() {
+ return tunnelId;
+ }
+
+ /**
+ * Returns tunnel name.
+ *
+ * @return tunnel name
+ */
+ public TunnelName tunnelName() {
+ return tunnelName;
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(consumerId, src, dst, type, tunnelId, tunnelName);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (obj instanceof TunnelSubscription) {
+ final TunnelSubscription other = (TunnelSubscription) obj;
+ return Objects.equals(this.src, other.src)
+ && Objects.equals(this.dst, other.dst)
+ && Objects.equals(this.consumerId, other.consumerId)
+ && Objects.equals(this.type, other.type)
+ && Objects.equals(this.tunnelId, other.tunnelId)
+ && Objects.equals(this.tunnelName, other.tunnelName);
+ }
+ return false;
+ }
+
+ @Override
+ public String toString() {
+ return MoreObjects.toStringHelper(getClass())
+ .add("src", src)
+ .add("dst", dst)
+ .add("consumerId", consumerId)
+ .add("type", type)
+ .add("tunnelId", tunnelId)
+ .add("tunnelName", tunnelName).toString();
+ }
+}
diff --git a/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/package-info.java b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/package-info.java
new file mode 100644
index 0000000..86e21f8
--- /dev/null
+++ b/apps/tunnel/api/src/main/java/org/onosproject/incubator/net/tunnel/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.
+ */
+
+/**
+ * Tunnel model related services and providers API definitions.
+ */
+package org.onosproject.incubator.net.tunnel;
diff --git a/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/resource/label/DefaultLabelResourceTest.java b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/resource/label/DefaultLabelResourceTest.java
new file mode 100644
index 0000000..9aabf06
--- /dev/null
+++ b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/resource/label/DefaultLabelResourceTest.java
@@ -0,0 +1,46 @@
+/*
+ * Copyright 2015-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label;
+
+import org.junit.Test;
+import org.onosproject.event.AbstractEventTest;
+
+import com.google.common.testing.EqualsTester;
+
+/**
+ * Tests of default label resource.
+ */
+public class DefaultLabelResourceTest extends AbstractEventTest {
+
+ @Test
+ public void testEquality() {
+ String deviceId1 = "of:001";
+ String deviceId2 = "of:002";
+ long labelResourceId1 = 100;
+ long labelResourceId2 = 200;
+ DefaultLabelResource h1 = new DefaultLabelResource(deviceId1,
+ labelResourceId1);
+ DefaultLabelResource h2 = new DefaultLabelResource(deviceId1,
+ labelResourceId1);
+ DefaultLabelResource h3 = new DefaultLabelResource(deviceId2,
+ labelResourceId2);
+ DefaultLabelResource h4 = new DefaultLabelResource(deviceId2,
+ labelResourceId2);
+
+ new EqualsTester().addEqualityGroup(h1, h2).addEqualityGroup(h3, h4)
+ .testEquals();
+ }
+}
diff --git a/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/resource/label/LabelResourceAdapter.java b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/resource/label/LabelResourceAdapter.java
new file mode 100644
index 0000000..d09a1de
--- /dev/null
+++ b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/resource/label/LabelResourceAdapter.java
@@ -0,0 +1,184 @@
+/*
+ * Copyright 2016-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label;
+
+import com.google.common.collect.Multimap;
+import org.onosproject.net.Device;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.device.DeviceEvent;
+import org.onosproject.net.device.DeviceEvent.Type;
+import org.onosproject.net.device.DeviceListener;
+import org.onosproject.net.provider.AbstractListenerProviderRegistry;
+import org.onosproject.net.provider.AbstractProviderService;
+
+import java.util.Collection;
+import java.util.LinkedList;
+import java.util.Random;
+import java.util.Set;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+/**
+ * Provides test implementation of class LabelResourceService.
+ */
+public class LabelResourceAdapter
+ extends AbstractListenerProviderRegistry<LabelResourceEvent, LabelResourceListener,
+ LabelResourceProvider, LabelResourceProviderService>
+ implements LabelResourceService, LabelResourceAdminService, LabelResourceProviderRegistry {
+ public static final long GLOBAL_LABEL_SPACE_MIN = 4097;
+ public static final long GLOBAL_LABEL_SPACE_MAX = 5121;
+ public static final long LOCAL_LABEL_SPACE_MIN = 5122;
+ public static final long LOCAL_LABEL_SPACE_MAX = 9217;
+
+ private Random random = new Random();
+
+ @Override
+ public boolean createDevicePool(DeviceId deviceId,
+ LabelResourceId beginLabel,
+ LabelResourceId endLabel) {
+ return true;
+ }
+
+ @Override
+ public boolean createGlobalPool(LabelResourceId beginLabel,
+ LabelResourceId endLabel) {
+ return true;
+ }
+
+ @Override
+ public boolean destroyDevicePool(DeviceId deviceId) {
+ return true;
+ }
+
+ @Override
+ public boolean destroyGlobalPool() {
+ return true;
+ }
+
+ public long getLabelId(long min, long max) {
+ return random.nextInt((int) max - (int) min + 1) + (int) min;
+ }
+
+ @Override
+ public Collection<LabelResource> applyFromDevicePool(DeviceId deviceId,
+ long applyNum) {
+ Collection<LabelResource> labelList = new LinkedList<>();
+ LabelResource label = new DefaultLabelResource(deviceId,
+ LabelResourceId.labelResourceId(
+ getLabelId(LOCAL_LABEL_SPACE_MIN, LOCAL_LABEL_SPACE_MAX)));
+ labelList.add(label);
+ return labelList;
+ }
+
+ @Override
+ public Collection<LabelResource> applyFromGlobalPool(long applyNum) {
+ Collection<LabelResource> labelList = new LinkedList<>();
+ LabelResource label = new DefaultLabelResource(DeviceId.deviceId("foo"),
+ LabelResourceId.labelResourceId(
+ getLabelId(GLOBAL_LABEL_SPACE_MIN, GLOBAL_LABEL_SPACE_MAX)));
+ labelList.add(label);
+ return labelList;
+ }
+
+ @Override
+ public boolean releaseToDevicePool(Multimap<DeviceId, LabelResource> release) {
+ return true;
+ }
+
+ @Override
+ public boolean releaseToGlobalPool(Set<LabelResourceId> release) {
+ return true;
+ }
+
+ @Override
+ public boolean isDevicePoolFull(DeviceId deviceId) {
+ return false;
+ }
+
+ @Override
+ public boolean isGlobalPoolFull() {
+ return false;
+ }
+
+ @Override
+ public long getFreeNumOfDevicePool(DeviceId deviceId) {
+ return 4;
+ }
+
+ @Override
+ public long getFreeNumOfGlobalPool() {
+ return 4;
+ }
+
+ @Override
+ public LabelResourcePool getDeviceLabelResourcePool(DeviceId deviceId) {
+ return null;
+ }
+
+ @Override
+ public LabelResourcePool getGlobalLabelResourcePool() {
+ return null;
+ }
+
+ private class InternalLabelResourceDelegate implements LabelResourceDelegate {
+ @Override
+ public void notify(LabelResourceEvent event) {
+ post(event);
+ }
+
+ }
+
+ private class InternalDeviceListener implements DeviceListener {
+ @Override
+ public void event(DeviceEvent event) {
+ Device device = event.subject();
+ if (Type.DEVICE_REMOVED.equals(event.type())) {
+ destroyDevicePool(device.id());
+ }
+ }
+ }
+
+ private class InternalLabelResourceProviderService
+ extends AbstractProviderService<LabelResourceProvider>
+ implements LabelResourceProviderService {
+
+ protected InternalLabelResourceProviderService(LabelResourceProvider provider) {
+ super(provider);
+ }
+
+ @Override
+ public void deviceLabelResourcePoolDetected(DeviceId deviceId,
+ LabelResourceId beginLabel,
+ LabelResourceId endLabel) {
+ checkNotNull(deviceId, "deviceId is not null");
+ checkNotNull(beginLabel, "beginLabel is not null");
+ checkNotNull(endLabel, "endLabel is not null");
+ createDevicePool(deviceId, beginLabel, endLabel);
+ }
+
+ @Override
+ public void deviceLabelResourcePoolDestroyed(DeviceId deviceId) {
+ checkNotNull(deviceId, "deviceId is not null");
+ destroyDevicePool(deviceId);
+ }
+
+ }
+
+ @Override
+ protected LabelResourceProviderService createProviderService(LabelResourceProvider provider) {
+ return null;
+ }
+}
diff --git a/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/resource/label/LabelResourcePoolTest.java b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/resource/label/LabelResourcePoolTest.java
new file mode 100644
index 0000000..e4b791e
--- /dev/null
+++ b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/resource/label/LabelResourcePoolTest.java
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2015-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label;
+
+import org.junit.Test;
+import org.onosproject.event.AbstractEventTest;
+
+import com.google.common.testing.EqualsTester;
+
+/**
+ * Tests of the label resource pool.
+ */
+public class LabelResourcePoolTest extends AbstractEventTest {
+
+ @Test
+ public void testEquality() {
+ LabelResourcePool h1 = new LabelResourcePool("of:001", 0, 100);
+ LabelResourcePool h2 = new LabelResourcePool("of:001", 0, 100);
+ LabelResourcePool h3 = new LabelResourcePool("of:002", 0, 100);
+ LabelResourcePool h4 = new LabelResourcePool("of:002", 0, 100);
+ new EqualsTester().addEqualityGroup(h1, h2).addEqualityGroup(h3, h4)
+ .testEquals();
+ }
+
+}
diff --git a/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/resource/label/LabelResourceRequestTest.java b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/resource/label/LabelResourceRequestTest.java
new file mode 100644
index 0000000..e379132
--- /dev/null
+++ b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/resource/label/LabelResourceRequestTest.java
@@ -0,0 +1,59 @@
+/*
+ * Copyright 2015-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label;
+
+import java.util.Collections;
+
+import org.junit.Test;
+import org.onosproject.event.AbstractEventTest;
+import org.onosproject.net.DeviceId;
+
+import com.google.common.collect.ImmutableSet;
+import com.google.common.testing.EqualsTester;
+
+/**
+ * Tests of the label resource request.
+ */
+public class LabelResourceRequestTest extends AbstractEventTest {
+
+ @Test
+ public void testEquality() {
+ DeviceId deviceId1 = DeviceId.deviceId("of:0001");
+ DeviceId deviceId2 = DeviceId.deviceId("of:0002");
+ long apply = 2;
+ ImmutableSet<LabelResource> releaseCollection = ImmutableSet
+ .copyOf(Collections.emptySet());
+ LabelResourceRequest h1 = new LabelResourceRequest(
+ deviceId1,
+ LabelResourceRequest.Type.APPLY,
+ apply, null);
+ LabelResourceRequest h2 = new LabelResourceRequest(
+ deviceId1,
+ LabelResourceRequest.Type.APPLY,
+ apply, null);
+ LabelResourceRequest h3 = new LabelResourceRequest(
+ deviceId2,
+ LabelResourceRequest.Type.RELEASE,
+ 0, releaseCollection);
+ LabelResourceRequest h4 = new LabelResourceRequest(
+ deviceId2,
+ LabelResourceRequest.Type.RELEASE,
+ 0, releaseCollection);
+
+ new EqualsTester().addEqualityGroup(h1, h2).addEqualityGroup(h3, h4)
+ .testEquals();
+ }
+}
diff --git a/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/tunnel/DefaultTunnelTest.java b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/tunnel/DefaultTunnelTest.java
new file mode 100644
index 0000000..7f31523
--- /dev/null
+++ b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/tunnel/DefaultTunnelTest.java
@@ -0,0 +1,62 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import static org.onlab.junit.ImmutableClassChecker.assertThatClassIsImmutable;
+
+import org.junit.Test;
+import org.onlab.packet.IpAddress;
+import org.onosproject.core.GroupId;
+import org.onosproject.net.provider.ProviderId;
+
+import com.google.common.testing.EqualsTester;
+
+/**
+ * Test of the default tunnel model entity.
+ */
+public class DefaultTunnelTest {
+ /**
+ * Checks that the Order class is immutable.
+ */
+ @Test
+ public void testImmutability() {
+ assertThatClassIsImmutable(DefaultTunnel.class);
+ }
+
+ @Test
+ public void testEquality() {
+ TunnelEndPoint src = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(23423));
+ TunnelEndPoint dst = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(32421));
+ GroupId groupId = new GroupId(92034);
+ TunnelName tunnelName = TunnelName.tunnelName("TunnelName");
+ TunnelId tunnelId = TunnelId.valueOf("41654654");
+ ProviderId producerName1 = new ProviderId("producer1", "13");
+ ProviderId producerName2 = new ProviderId("producer2", "13");
+ Tunnel p1 = new DefaultTunnel(producerName1, src, dst, Tunnel.Type.VXLAN,
+ Tunnel.State.ACTIVE, groupId, tunnelId,
+ tunnelName, null);
+ Tunnel p2 = new DefaultTunnel(producerName1, src, dst, Tunnel.Type.VXLAN,
+ Tunnel.State.ACTIVE, groupId, tunnelId,
+ tunnelName, null);
+ Tunnel p3 = new DefaultTunnel(producerName2, src, dst, Tunnel.Type.OCH,
+ Tunnel.State.ACTIVE, groupId, tunnelId,
+ tunnelName, null);
+ new EqualsTester().addEqualityGroup(p1, p2).addEqualityGroup(p3)
+ .testEquals();
+ }
+}
diff --git a/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/tunnel/TunnelEventTest.java b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/tunnel/TunnelEventTest.java
new file mode 100644
index 0000000..0483b54
--- /dev/null
+++ b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/tunnel/TunnelEventTest.java
@@ -0,0 +1,61 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.notNullValue;
+import static org.onlab.junit.ImmutableClassChecker.assertThatClassIsImmutable;
+
+import org.junit.Test;
+import org.onlab.packet.IpAddress;
+import org.onosproject.core.GroupId;
+import org.onosproject.net.provider.ProviderId;
+
+/**
+ * Test of a tunnel event.
+ */
+public class TunnelEventTest {
+ /**
+ * Checks that the Order class is immutable.
+ */
+ @Test
+ public void testImmutability() {
+ assertThatClassIsImmutable(TunnelEvent.class);
+ }
+
+ /**
+ * Checks the operation of equals(), hashCode() and toString() methods.
+ */
+ @Test
+ public void testConstructor() {
+ TunnelEndPoint src = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(23423));
+ TunnelEndPoint dst = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(32421));
+ GroupId groupId = new GroupId(92034);
+ TunnelName tunnelName = TunnelName.tunnelName("TunnelName");
+ TunnelId tunnelId = TunnelId.valueOf("41654654");
+ ProviderId producerName1 = new ProviderId("producer1", "13");
+ Tunnel p1 = new DefaultTunnel(producerName1, src, dst, Tunnel.Type.VXLAN,
+ Tunnel.State.ACTIVE, groupId, tunnelId,
+ tunnelName, null);
+ TunnelEvent e1 = new TunnelEvent(TunnelEvent.Type.TUNNEL_ADDED, p1);
+ assertThat(e1, is(notNullValue()));
+ assertThat(e1.type(), is(TunnelEvent.Type.TUNNEL_ADDED));
+ assertThat(e1.subject(), is(p1));
+ }
+}
diff --git a/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/tunnel/TunnelIdTest.java b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/tunnel/TunnelIdTest.java
new file mode 100644
index 0000000..50d4051
--- /dev/null
+++ b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/tunnel/TunnelIdTest.java
@@ -0,0 +1,66 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.notNullValue;
+import static org.onlab.junit.ImmutableClassChecker.assertThatClassIsImmutable;
+
+import org.junit.Test;
+
+import com.google.common.testing.EqualsTester;
+
+/**
+ * Unit tests for tunnel id class.
+ */
+public class TunnelIdTest {
+
+ final TunnelId tunnelId1 = TunnelId.valueOf("1");
+ final TunnelId sameAstunnelId1 = TunnelId.valueOf("1");
+ final TunnelId tunnelId2 = TunnelId.valueOf("2");
+
+ /**
+ * Checks that the TunnelId class is immutable.
+ */
+ @Test
+ public void testImmutability() {
+ assertThatClassIsImmutable(TunnelId.class);
+ }
+
+ /**
+ * Checks the operation of equals(), hashCode() and toString() methods.
+ */
+ @Test
+ public void testEquals() {
+ new EqualsTester()
+ .addEqualityGroup(tunnelId1, sameAstunnelId1)
+ .addEqualityGroup(tunnelId2)
+ .testEquals();
+ }
+
+ /**
+ * Checks the construction of a FlowId object.
+ */
+ @Test
+ public void testConstruction() {
+ final String tunnelIdValue = "7777";
+ final TunnelId tunnelId = TunnelId.valueOf(tunnelIdValue);
+ assertThat(tunnelId, is(notNullValue()));
+ assertThat(tunnelId.id(), is(tunnelIdValue));
+ }
+}
diff --git a/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/tunnel/TunnelNameTest.java b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/tunnel/TunnelNameTest.java
new file mode 100644
index 0000000..8e59a29
--- /dev/null
+++ b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/tunnel/TunnelNameTest.java
@@ -0,0 +1,64 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.notNullValue;
+import static org.onlab.junit.ImmutableClassChecker.assertThatClassIsImmutable;
+
+import org.junit.Test;
+
+import com.google.common.testing.EqualsTester;
+
+/**
+ * Unit tests for tunnel name class.
+ */
+public class TunnelNameTest {
+ final TunnelName name1 = TunnelName.tunnelName("name1");
+ final TunnelName sameAsName1 = TunnelName.tunnelName("name1");
+ final TunnelName name2 = TunnelName.tunnelName("name2");
+
+ /**
+ * Checks that the TunnelName class is immutable.
+ */
+ @Test
+ public void testImmutability() {
+ assertThatClassIsImmutable(TunnelName.class);
+ }
+
+ /**
+ * Checks the operation of equals(), hashCode() and toString() methods.
+ */
+ @Test
+ public void testEquals() {
+ new EqualsTester().addEqualityGroup(name1, sameAsName1)
+ .addEqualityGroup(name2).testEquals();
+ }
+
+ /**
+ * Checks the construction of a OpenFlowGroupId object.
+ */
+ @Test
+ public void testConstruction() {
+ final String nameValue = "name3";
+ final TunnelName name = TunnelName.tunnelName(nameValue);
+ assertThat(name, is(notNullValue()));
+ assertThat(name.value(), is(nameValue));
+ }
+
+}
diff --git a/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/tunnel/TunnelServiceAdapter.java b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/tunnel/TunnelServiceAdapter.java
new file mode 100644
index 0000000..dcf3666
--- /dev/null
+++ b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/tunnel/TunnelServiceAdapter.java
@@ -0,0 +1,127 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import org.onosproject.core.ApplicationId;
+import org.onosproject.net.Annotations;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.ElementId;
+import org.onosproject.net.Path;
+
+import java.util.Collection;
+import java.util.Collections;
+
+public class TunnelServiceAdapter implements TunnelService {
+ @Override
+ public Tunnel borrowTunnel(ApplicationId consumerId, TunnelId tunnelId, Annotations... annotations) {
+ return null;
+ }
+
+ @Override
+ public Collection<Tunnel> borrowTunnel(ApplicationId consumerId, TunnelName tunnelName,
+ Annotations... annotations) {
+ return null;
+ }
+
+ @Override
+ public Collection<Tunnel> borrowTunnel(ApplicationId consumerId, TunnelEndPoint src, TunnelEndPoint dst,
+ Annotations... annotations) {
+ return null;
+ }
+
+ @Override
+ public Collection<Tunnel> borrowTunnel(ApplicationId consumerId, TunnelEndPoint src, TunnelEndPoint dst,
+ Tunnel.Type type, Annotations... annotations) {
+ return null;
+ }
+
+ @Override
+ public TunnelId setupTunnel(ApplicationId producerId, ElementId srcElementId, Tunnel tunnel, Path path) {
+ return null;
+ }
+
+ @Override
+ public boolean downTunnel(ApplicationId producerId, TunnelId tunnelId) {
+ return false;
+ }
+
+ @Override
+ public boolean returnTunnel(ApplicationId consumerId, TunnelId tunnelId, Annotations... annotations) {
+ return false;
+ }
+
+ @Override
+ public boolean returnTunnel(ApplicationId consumerId, TunnelName tunnelName, Annotations... annotations) {
+ return false;
+ }
+
+ @Override
+ public boolean returnTunnel(ApplicationId consumerId, TunnelEndPoint src, TunnelEndPoint dst,
+ Tunnel.Type type, Annotations... annotations) {
+ return false;
+ }
+
+ @Override
+ public boolean returnTunnel(ApplicationId consumerId, TunnelEndPoint src, TunnelEndPoint dst,
+ Annotations... annotations) {
+ return false;
+ }
+
+ @Override
+ public Tunnel queryTunnel(TunnelId tunnelId) {
+ return null;
+ }
+
+ @Override
+ public Collection<TunnelSubscription> queryTunnelSubscription(ApplicationId consumerId) {
+ return Collections.emptySet();
+ }
+
+ @Override
+ public Collection<Tunnel> queryTunnel(Tunnel.Type type) {
+ return Collections.emptySet();
+ }
+
+ @Override
+ public Collection<Tunnel> queryTunnel(TunnelEndPoint src, TunnelEndPoint dst) {
+ return Collections.emptySet();
+ }
+
+ @Override
+ public Collection<Tunnel> queryAllTunnels() {
+ return Collections.emptyList();
+ }
+
+ @Override
+ public int tunnelCount() {
+ return 0;
+ }
+
+ @Override
+ public Iterable<Tunnel> getTunnels(DeviceId deviceId) {
+ return null;
+ }
+
+ @Override
+ public void addListener(TunnelListener listener) {
+
+ }
+
+ @Override
+ public void removeListener(TunnelListener listener) {
+
+ }
+}
diff --git a/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/tunnel/TunnelSubscriptionTest.java b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/tunnel/TunnelSubscriptionTest.java
new file mode 100644
index 0000000..fc60ee4
--- /dev/null
+++ b/apps/tunnel/api/src/test/java/org/onosproject/incubator/net/tunnel/TunnelSubscriptionTest.java
@@ -0,0 +1,58 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel;
+
+import static org.onlab.junit.ImmutableClassChecker.assertThatClassIsImmutable;
+
+import org.junit.Test;
+import org.onlab.packet.IpAddress;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.core.DefaultApplicationId;
+
+import com.google.common.testing.EqualsTester;
+
+/**
+ * Test of order model entity.
+ */
+public class TunnelSubscriptionTest {
+ /**
+ * Checks that the Order class is immutable.
+ */
+ @Test
+ public void testImmutability() {
+ assertThatClassIsImmutable(TunnelSubscription.class);
+ }
+
+ /**
+ * Checks the operation of equals(), hashCode() and toString() methods.
+ */
+ @Test
+ public void testEquality() {
+ TunnelEndPoint src = IpTunnelEndPoint.ipTunnelPoint(IpAddress.valueOf(23423));
+ TunnelEndPoint dst = IpTunnelEndPoint.ipTunnelPoint(IpAddress.valueOf(32421));
+ ApplicationId appId = new DefaultApplicationId(243, "test");
+ ApplicationId appId2 = new DefaultApplicationId(2431, "test1");
+ TunnelId tunnelId = TunnelId.valueOf("41654654");
+ TunnelSubscription p1 = new TunnelSubscription(appId, src, dst, tunnelId, Tunnel.Type.VXLAN,
+ null);
+ TunnelSubscription p2 = new TunnelSubscription(appId, src, dst, tunnelId, Tunnel.Type.VXLAN,
+ null);
+ TunnelSubscription p3 = new TunnelSubscription(appId2, src, dst, tunnelId, Tunnel.Type.VXLAN,
+ null);
+ new EqualsTester().addEqualityGroup(p1, p2).addEqualityGroup(p3)
+ .testEquals();
+ }
+}
diff --git a/apps/tunnel/app/BUILD b/apps/tunnel/app/BUILD
new file mode 100644
index 0000000..82a8cac
--- /dev/null
+++ b/apps/tunnel/app/BUILD
@@ -0,0 +1,12 @@
+COMPILE_DEPS = CORE_DEPS + JACKSON + REST + CLI + [
+ "//core/store/serializers:onos-core-serializers",
+ "//apps/tunnel/api:onos-apps-tunnel-api",
+]
+
+TEST_DEPS = TEST_ADAPTERS
+
+osgi_jar_with_tests(
+ test_deps = TEST_DEPS,
+ visibility = ["//visibility:public"],
+ deps = COMPILE_DEPS,
+)
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/domain/impl/IntentDomainManager.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/domain/impl/IntentDomainManager.java
new file mode 100644
index 0000000..5d0270b
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/domain/impl/IntentDomainManager.java
@@ -0,0 +1,113 @@
+/*
+ * Copyright 2015-present Open Networking Foundation
+ *
+ * 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.incubator.net.domain.impl;
+
+import com.google.common.collect.ImmutableSet;
+import com.google.common.collect.Maps;
+import org.onosproject.incubator.net.domain.IntentDomain;
+import org.onosproject.incubator.net.domain.IntentDomainEvent;
+import org.onosproject.incubator.net.domain.IntentDomainId;
+import org.onosproject.incubator.net.domain.IntentDomainListener;
+import org.onosproject.incubator.net.domain.IntentDomainProvider;
+import org.onosproject.incubator.net.domain.IntentDomainProviderRegistry;
+import org.onosproject.incubator.net.domain.IntentDomainProviderService;
+import org.onosproject.incubator.net.domain.IntentDomainService;
+import org.onosproject.incubator.net.domain.IntentPrimitive;
+import org.onosproject.incubator.net.domain.IntentResource;
+import org.onosproject.net.ConnectPoint;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.provider.AbstractListenerProviderRegistry;
+import org.onosproject.net.provider.AbstractProviderService;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Deactivate;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.List;
+import java.util.Set;
+import java.util.concurrent.ConcurrentMap;
+import java.util.stream.Collectors;
+
+/**
+ * Implementation of the intent domain service.
+ */
+@Component(immediate = true, service = {IntentDomainService.class, IntentDomainProviderRegistry.class})
+public class IntentDomainManager
+ extends AbstractListenerProviderRegistry<IntentDomainEvent, IntentDomainListener,
+ IntentDomainProvider, IntentDomainProviderService>
+ implements IntentDomainService, IntentDomainProviderRegistry {
+
+ private final Logger log = LoggerFactory.getLogger(getClass());
+
+ private final ConcurrentMap<IntentDomainId, IntentDomain> domains = Maps.newConcurrentMap();
+
+ @Activate
+ protected void activate() {
+ log.info("Started");
+ }
+
+ @Deactivate
+ protected void deactivate() {
+ log.info("Stopped");
+ }
+
+ @Override
+ public IntentDomain getDomain(IntentDomainId id) {
+ return domains.get(id);
+ }
+
+ @Override
+ public Set<IntentDomain> getDomains() {
+ return ImmutableSet.copyOf(domains.values());
+ }
+
+ @Override
+ public Set<IntentDomain> getDomains(DeviceId deviceId) {
+ return domains.values().stream()
+ .filter(domain ->
+ domain.internalDevices().contains(deviceId) ||
+ domain.edgePorts().stream()
+ .map(ConnectPoint::deviceId)
+ .anyMatch(d -> d.equals(deviceId)))
+ .collect(Collectors.toSet());
+ }
+
+ @Override
+ public List<IntentResource> request(IntentDomainId domainId, IntentPrimitive primitive) {
+ IntentDomain domain = getDomain(domainId);
+ return domain.provider().request(domain, primitive);
+ }
+
+ @Override
+ public void submit(IntentDomainId domainId, IntentResource resource) {
+ getDomain(domainId).provider().apply(resource);
+ }
+
+ @Override
+ protected IntentDomainProviderService createProviderService(IntentDomainProvider provider) {
+ return new InternalDomainProviderService(provider);
+ }
+
+ private class InternalDomainProviderService
+ extends AbstractProviderService<IntentDomainProvider>
+ implements IntentDomainProviderService {
+
+ InternalDomainProviderService(IntentDomainProvider provider) {
+ super(provider);
+ }
+ }
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/domain/impl/package-info.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/domain/impl/package-info.java
new file mode 100644
index 0000000..17b9f86
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/domain/impl/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2015-present Open Networking Foundation
+ *
+ * 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.
+ */
+
+/**
+ * Implementation of the intent domain subsystem.
+ */
+package org.onosproject.incubator.net.domain.impl;
\ No newline at end of file
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/GlobalLabelApplyCommand.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/GlobalLabelApplyCommand.java
new file mode 100644
index 0000000..c5d9e8e
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/GlobalLabelApplyCommand.java
@@ -0,0 +1,56 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label.cli;
+
+import java.util.Collection;
+import java.util.Iterator;
+
+import org.apache.karaf.shell.api.action.Argument;
+import org.apache.karaf.shell.api.action.Command;
+import org.apache.karaf.shell.api.action.lifecycle.Service;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.incubator.net.resource.label.DefaultLabelResource;
+import org.onosproject.incubator.net.resource.label.LabelResource;
+import org.onosproject.incubator.net.resource.label.LabelResourceService;
+
+@Service
+@Command(scope = "onos", name = "global-label-apply",
+ description = "Apply global labels from global resource pool")
+public class GlobalLabelApplyCommand extends AbstractShellCommand {
+ @Argument(index = 0, name = "applyNum",
+ description = "Applying number means how many labels applications want to use.",
+ required = true, multiValued = false)
+ String applyNum = null;
+
+ private static final String FMT = "deviceid=%s, labelresourceid=%s";
+
+ @Override
+ protected void doExecute() {
+ LabelResourceService lrs = get(LabelResourceService.class);
+ Collection<LabelResource> result =
+ lrs.applyFromGlobalPool(Long.parseLong(applyNum));
+ if (!result.isEmpty()) {
+ for (Iterator<LabelResource> iterator = result.iterator(); iterator
+ .hasNext();) {
+ DefaultLabelResource defaultLabelResource = (DefaultLabelResource) iterator
+ .next();
+ print(FMT, defaultLabelResource.deviceId().toString(),
+ defaultLabelResource.labelResourceId().toString());
+ }
+ }
+ }
+
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/GlobalLabelCommand.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/GlobalLabelCommand.java
new file mode 100644
index 0000000..d93bf6f
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/GlobalLabelCommand.java
@@ -0,0 +1,44 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label.cli;
+
+import org.apache.karaf.shell.api.action.Command;
+import org.apache.karaf.shell.api.action.lifecycle.Service;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.incubator.net.resource.label.LabelResourcePool;
+import org.onosproject.incubator.net.resource.label.LabelResourceService;
+
+@Service
+@Command(scope = "onos", name = "global-label-pool",
+ description = "Gets global label resource pool information.")
+public class GlobalLabelCommand extends AbstractShellCommand {
+ private static final String FMT = "deviceid=%s, beginLabel=%s,"
+ + "endLabel=%s, totalNum=%s, usedNum=%s, currentUsedMaxLabelId=%s,"
+ + "releaseLabelIds=%s";
+
+ @Override
+ protected void doExecute() {
+ LabelResourceService lrs = get(LabelResourceService.class);
+ LabelResourcePool pool = lrs.getGlobalLabelResourcePool();
+ if (pool != null) {
+ print(FMT, pool.deviceId().toString(), pool.beginLabel(),
+ pool.endLabel(), pool.totalNum(), pool.usedNum(),
+ pool.currentUsedMaxLabelId(), pool.releaseLabelId()
+ .toString());
+ }
+ }
+
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/GlobalLabelPoolCreateCommand.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/GlobalLabelPoolCreateCommand.java
new file mode 100644
index 0000000..605f7c2
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/GlobalLabelPoolCreateCommand.java
@@ -0,0 +1,49 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label.cli;
+
+import org.apache.karaf.shell.api.action.Argument;
+import org.apache.karaf.shell.api.action.Command;
+import org.apache.karaf.shell.api.action.lifecycle.Service;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.incubator.net.resource.label.LabelResourceAdminService;
+import org.onosproject.incubator.net.resource.label.LabelResourceId;
+
+/**
+ * create label resource pool by specific device id.
+ */
+@Service
+@Command(scope = "onos", name = "global-label-pool-create",
+description = "Creates global label resource pool.")
+public class GlobalLabelPoolCreateCommand extends AbstractShellCommand {
+ @Argument(index = 0, name = "beginLabel",
+ description = "The first label of global label resource pool.",
+ required = true, multiValued = false)
+ String beginLabel = null;
+ @Argument(index = 1, name = "endLabel",
+ description = "The last label of global label resource pool.",
+ required = true, multiValued = false)
+ String endLabel = null;
+
+ @Override
+ protected void doExecute() {
+ LabelResourceAdminService lrs = get(LabelResourceAdminService.class);
+ lrs.createGlobalPool(LabelResourceId.labelResourceId(Long
+ .parseLong(beginLabel)), LabelResourceId.labelResourceId(Long
+ .parseLong(endLabel)));
+ }
+
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/GlobalLabelPoolDestroyCommand.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/GlobalLabelPoolDestroyCommand.java
new file mode 100644
index 0000000..09c70375
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/GlobalLabelPoolDestroyCommand.java
@@ -0,0 +1,33 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label.cli;
+
+import org.apache.karaf.shell.api.action.Command;
+import org.apache.karaf.shell.api.action.lifecycle.Service;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.incubator.net.resource.label.LabelResourceAdminService;
+
+@Service
+@Command(scope = "onos", name = "global-label-pool-destroy",
+description = "Destroys global label resource pool")
+public class GlobalLabelPoolDestroyCommand extends AbstractShellCommand {
+ @Override
+ protected void doExecute() {
+ LabelResourceAdminService lrs = get(LabelResourceAdminService.class);
+ lrs.destroyGlobalPool();
+ }
+
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/GlobalLabelReleaseCommand.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/GlobalLabelReleaseCommand.java
new file mode 100644
index 0000000..3a692be
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/GlobalLabelReleaseCommand.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label.cli;
+
+import java.util.HashSet;
+import java.util.Set;
+
+import org.apache.karaf.shell.api.action.Argument;
+import org.apache.karaf.shell.api.action.Command;
+import org.apache.karaf.shell.api.action.lifecycle.Service;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.incubator.net.resource.label.LabelResourceId;
+import org.onosproject.incubator.net.resource.label.LabelResourceService;
+
+@Service
+@Command(scope = "onos", name = "global-label-release",
+description = "Releases labels to global label resource pool.")
+public class GlobalLabelReleaseCommand extends AbstractShellCommand {
+ @Argument(index = 0, name = "releaseLabelIds",
+ description = "Represents for the label ids that are released. They are splited by dot symbol",
+ required = true, multiValued = false)
+ String releaseLabelIds = null;
+
+ @Override
+ protected void doExecute() {
+ LabelResourceService lrs = get(LabelResourceService.class);
+ Set<LabelResourceId> release = new HashSet<LabelResourceId>();
+ String[] labelIds = releaseLabelIds.split(",");
+ LabelResourceId resource = null;
+ for (int i = 0; i < labelIds.length; i++) {
+ resource = LabelResourceId.labelResourceId(Long.parseLong(labelIds[i]));
+ release.add(resource);
+ }
+ lrs.releaseToGlobalPool(release);
+ }
+
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/LabelApplyCommand.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/LabelApplyCommand.java
new file mode 100644
index 0000000..c7634fa
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/LabelApplyCommand.java
@@ -0,0 +1,61 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label.cli;
+
+import java.util.Collection;
+import java.util.Iterator;
+
+import org.apache.karaf.shell.api.action.Argument;
+import org.apache.karaf.shell.api.action.Command;
+import org.apache.karaf.shell.api.action.lifecycle.Service;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.net.DeviceId;
+import org.onosproject.incubator.net.resource.label.DefaultLabelResource;
+import org.onosproject.incubator.net.resource.label.LabelResource;
+import org.onosproject.incubator.net.resource.label.LabelResourceService;
+
+@Service
+@Command(scope = "onos", name = "label-apply",
+ description = "Apply label resource from device pool by specific device id")
+public class LabelApplyCommand extends AbstractShellCommand {
+ @Argument(index = 0, name = "deviceId",
+ description = "Device identity",
+ required = true, multiValued = false)
+ String deviceId = null;
+ @Argument(index = 1, name = "applyNum",
+ description = "Applying number means how many labels applications want to use.",
+ required = true, multiValued = false)
+ String applyNum = null;
+
+ private static final String FMT = "deviceid=%s, labelresourceid=%s";
+
+ @Override
+ protected void doExecute() {
+ LabelResourceService lrs = get(LabelResourceService.class);
+ Collection<LabelResource> result = lrs.applyFromDevicePool(DeviceId
+ .deviceId(deviceId), Long.parseLong(applyNum));
+ if (!result.isEmpty()) {
+ for (Iterator<LabelResource> iterator = result.iterator(); iterator
+ .hasNext();) {
+ DefaultLabelResource defaultLabelResource = (DefaultLabelResource) iterator
+ .next();
+ print(FMT, defaultLabelResource.deviceId().toString(),
+ defaultLabelResource.labelResourceId().toString());
+ }
+ }
+ }
+
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/LabelPoolCreateCommand.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/LabelPoolCreateCommand.java
new file mode 100644
index 0000000..775c269
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/LabelPoolCreateCommand.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label.cli;
+
+import org.apache.karaf.shell.api.action.Argument;
+import org.apache.karaf.shell.api.action.Command;
+import org.apache.karaf.shell.api.action.lifecycle.Service;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.net.DeviceId;
+import org.onosproject.incubator.net.resource.label.LabelResourceAdminService;
+import org.onosproject.incubator.net.resource.label.LabelResourceId;
+
+/**
+ * create label resource pool by specific device id.
+ */
+@Service
+@Command(scope = "onos", name = "label-pool-create",
+ description = "Creates label resource pool by a specific device id")
+public class LabelPoolCreateCommand extends AbstractShellCommand {
+ @Argument(index = 0, name = "deviceId", description = "Device identity", required = true, multiValued = false)
+ String deviceId = null;
+ @Argument(index = 1, name = "beginLabel",
+ description = "The first label of global label resource pool.", required = true, multiValued = false)
+ String beginLabel = null;
+ @Argument(index = 2, name = "endLabel",
+ description = "The last label of global label resource pool.", required = true, multiValued = false)
+ String endLabel = null;
+
+ @Override
+ protected void doExecute() {
+ LabelResourceAdminService lrs = get(LabelResourceAdminService.class);
+ lrs.createDevicePool(DeviceId.deviceId(deviceId), LabelResourceId
+ .labelResourceId(Long.parseLong(beginLabel)), LabelResourceId
+ .labelResourceId(Long.parseLong(endLabel)));
+ }
+
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/LabelPoolDestroyCommand.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/LabelPoolDestroyCommand.java
new file mode 100644
index 0000000..c875cd8
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/LabelPoolDestroyCommand.java
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label.cli;
+
+import org.apache.karaf.shell.api.action.Argument;
+import org.apache.karaf.shell.api.action.Command;
+import org.apache.karaf.shell.api.action.lifecycle.Service;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.net.DeviceId;
+import org.onosproject.incubator.net.resource.label.LabelResourceAdminService;
+
+@Service
+@Command(scope = "onos", name = "label-pool-destroy",
+ description = "Destroys label resource pool by a specific device id")
+public class LabelPoolDestroyCommand extends AbstractShellCommand {
+ @Argument(index = 0, name = "deviceId", description = "Device identity", required = true, multiValued = false)
+ String deviceId = null;
+
+ @Override
+ protected void doExecute() {
+ LabelResourceAdminService lrs = get(LabelResourceAdminService.class);
+ lrs.destroyDevicePool(DeviceId.deviceId(deviceId));
+ }
+
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/LabelReleaseCommand.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/LabelReleaseCommand.java
new file mode 100644
index 0000000..c511642
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/LabelReleaseCommand.java
@@ -0,0 +1,61 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label.cli;
+
+import org.apache.karaf.shell.api.action.Argument;
+import org.apache.karaf.shell.api.action.Command;
+import org.apache.karaf.shell.api.action.lifecycle.Service;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.net.DeviceId;
+import org.onosproject.incubator.net.resource.label.DefaultLabelResource;
+import org.onosproject.incubator.net.resource.label.LabelResource;
+import org.onosproject.incubator.net.resource.label.LabelResourceId;
+import org.onosproject.incubator.net.resource.label.LabelResourceService;
+
+import com.google.common.collect.ArrayListMultimap;
+import com.google.common.collect.Multimap;
+
+@Service
+@Command(scope = "onos", name = "label-release",
+description = "Releases label ids to label resource pool by a specific device id")
+public class LabelReleaseCommand extends AbstractShellCommand {
+ @Argument(index = 0, name = "deviceId",
+ description = "Device identity",
+ required = true, multiValued = false)
+ String deviceId = null;
+ @Argument(index = 1, name = "releaseLabelIds",
+ description = "Represents for the label ids that are released. They are splited by dot symbol",
+ required = true, multiValued = false)
+ String releaseLabelIds = null;
+
+ @Override
+ protected void doExecute() {
+ LabelResourceService lrs = get(LabelResourceService.class);
+ Multimap<DeviceId, LabelResource> map = ArrayListMultimap
+ .create();
+ String[] labelIds = releaseLabelIds.split(",");
+ DefaultLabelResource resource = null;
+ for (int i = 0; i < labelIds.length; i++) {
+ resource = new DefaultLabelResource(
+ DeviceId.deviceId(deviceId),
+ LabelResourceId.labelResourceId(Long
+ .parseLong(labelIds[i])));
+ map.put(DeviceId.deviceId(deviceId), resource);
+ }
+ lrs.releaseToDevicePool(map);
+ }
+
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/LabelResourceCommand.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/LabelResourceCommand.java
new file mode 100644
index 0000000..84c8f65
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/LabelResourceCommand.java
@@ -0,0 +1,52 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label.cli;
+
+import org.apache.karaf.shell.api.action.Argument;
+import org.apache.karaf.shell.api.action.Command;
+import org.apache.karaf.shell.api.action.lifecycle.Service;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.net.DeviceId;
+import org.onosproject.incubator.net.resource.label.LabelResourcePool;
+import org.onosproject.incubator.net.resource.label.LabelResourceService;
+
+@Service
+@Command(scope = "onos", name = "label-pool",
+ description = "Gets label resource pool information by a specific device id")
+public class LabelResourceCommand extends AbstractShellCommand {
+ @Argument(index = 0, name = "deviceId",
+ description = "Device identity", required = true, multiValued = false)
+ String deviceId = null;
+ private static final String FMT = "deviceid=%s, beginLabel=%s,"
+ + "endLabel=%s, totalNum=%s, usedNum=%s, currentUsedMaxLabelId=%s,"
+ + "releaseLabelIds=%s";
+
+ @Override
+ protected void doExecute() {
+ LabelResourceService lrs = get(LabelResourceService.class);
+ LabelResourcePool pool = lrs.getDeviceLabelResourcePool(DeviceId
+ .deviceId(deviceId));
+ if (pool != null) {
+ print(FMT, pool.deviceId().toString(), pool.beginLabel(),
+ pool.endLabel(), pool.totalNum(), pool.usedNum(),
+ pool.currentUsedMaxLabelId(), pool.releaseLabelId()
+ .toString());
+ } else {
+ print(FMT, deviceId, null, null, null, null, null, null);
+ }
+ }
+
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/package-info.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/package-info.java
new file mode 100644
index 0000000..0e8608f
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/cli/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.
+ */
+
+/**
+ * CLIs for the resource label subsystem.
+ */
+package org.onosproject.incubator.net.resource.label.cli;
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/impl/LabelResourceManager.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/impl/LabelResourceManager.java
new file mode 100644
index 0000000..ad9a133
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/impl/LabelResourceManager.java
@@ -0,0 +1,233 @@
+/*
+ * Copyright 2015-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label.impl;
+
+import com.google.common.collect.Multimap;
+import org.onosproject.incubator.net.resource.label.LabelResource;
+import org.onosproject.incubator.net.resource.label.LabelResourceAdminService;
+import org.onosproject.incubator.net.resource.label.LabelResourceDelegate;
+import org.onosproject.incubator.net.resource.label.LabelResourceEvent;
+import org.onosproject.incubator.net.resource.label.LabelResourceId;
+import org.onosproject.incubator.net.resource.label.LabelResourceListener;
+import org.onosproject.incubator.net.resource.label.LabelResourcePool;
+import org.onosproject.incubator.net.resource.label.LabelResourceProvider;
+import org.onosproject.incubator.net.resource.label.LabelResourceProviderRegistry;
+import org.onosproject.incubator.net.resource.label.LabelResourceProviderService;
+import org.onosproject.incubator.net.resource.label.LabelResourceService;
+import org.onosproject.incubator.net.resource.label.LabelResourceStore;
+import org.onosproject.net.Device;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.device.DeviceEvent;
+import org.onosproject.net.device.DeviceEvent.Type;
+import org.onosproject.net.device.DeviceListener;
+import org.onosproject.net.device.DeviceService;
+import org.onosproject.net.provider.AbstractListenerProviderRegistry;
+import org.onosproject.net.provider.AbstractProviderService;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Deactivate;
+import org.osgi.service.component.annotations.Reference;
+import org.osgi.service.component.annotations.ReferenceCardinality;
+import org.slf4j.Logger;
+
+import java.util.Collection;
+import java.util.Set;
+
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Preconditions.checkNotNull;
+import static org.slf4j.LoggerFactory.getLogger;
+
+/**
+ * provides implementation of the label resource NB & SB APIs.
+ *
+ */
+@Component(immediate = true,
+ service = {LabelResourceService.class, LabelResourceAdminService.class, LabelResourceProviderRegistry.class})
+public class LabelResourceManager
+ extends AbstractListenerProviderRegistry<LabelResourceEvent, LabelResourceListener,
+ LabelResourceProvider, LabelResourceProviderService>
+ implements LabelResourceService, LabelResourceAdminService, LabelResourceProviderRegistry {
+ private final Logger log = getLogger(getClass());
+ private final LabelResourceDelegate delegate = new InternalLabelResourceDelegate();
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY)
+ protected LabelResourceStore store;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY)
+ protected DeviceService deviceService;
+
+ private DeviceListener deviceListener = new InternalDeviceListener();
+
+ @Activate
+ public void activate() {
+ store.setDelegate(delegate);
+ eventDispatcher.addSink(LabelResourceEvent.class, listenerRegistry);
+ deviceService.addListener(deviceListener);
+ log.info("Started");
+
+ }
+
+ @Deactivate
+ public void deactivate() {
+ deviceService.removeListener(deviceListener);
+ store.unsetDelegate(delegate);
+ eventDispatcher.removeSink(LabelResourceEvent.class);
+ log.info("Stopped");
+ }
+
+ @Override
+ public boolean createDevicePool(DeviceId deviceId,
+ LabelResourceId beginLabel,
+ LabelResourceId endLabel) {
+ checkNotNull(deviceId, "deviceId is not null");
+ checkNotNull(beginLabel, "beginLabel is not null");
+ checkNotNull(endLabel, "endLabel is not null");
+ checkArgument(beginLabel.labelId() >= 0 || endLabel.labelId() >= 0,
+ "The value of beginLabel and the value of endLabel must be both positive number.");
+ checkArgument(beginLabel.labelId() < endLabel.labelId(),
+ "The value of endLabel must be greater than the value of beginLabel.");
+ return store.createDevicePool(deviceId, beginLabel, endLabel);
+ }
+
+ @Override
+ public boolean createGlobalPool(LabelResourceId beginLabel,
+ LabelResourceId endLabel) {
+ checkNotNull(beginLabel, "beginLabel is not null");
+ checkNotNull(endLabel, "endLabel is not null");
+ checkArgument(beginLabel.labelId() >= 0 && endLabel.labelId() >= 0,
+ "The value of beginLabel and the value of endLabel must be both positive number.");
+ checkArgument(beginLabel.labelId() < endLabel.labelId(),
+ "The value of endLabel must be greater than the value of beginLabel.");
+ return store.createGlobalPool(beginLabel, endLabel);
+ }
+
+ @Override
+ public boolean destroyDevicePool(DeviceId deviceId) {
+ checkNotNull(deviceId, "deviceId is not null");
+ return store.destroyDevicePool(deviceId);
+ }
+
+ @Override
+ public boolean destroyGlobalPool() {
+ return store.destroyGlobalPool();
+ }
+
+ @Override
+ public Collection<LabelResource> applyFromDevicePool(DeviceId deviceId,
+ long applyNum) {
+ checkNotNull(deviceId, "deviceId is not null");
+ return store.applyFromDevicePool(deviceId, applyNum);
+ }
+
+ @Override
+ public Collection<LabelResource> applyFromGlobalPool(long applyNum) {
+ return store.applyFromGlobalPool(applyNum);
+ }
+
+ @Override
+ public boolean releaseToDevicePool(Multimap<DeviceId, LabelResource> release) {
+ checkNotNull(release, "release is not null");
+ return store.releaseToDevicePool(release);
+ }
+
+ @Override
+ public boolean releaseToGlobalPool(Set<LabelResourceId> release) {
+ checkNotNull(release, "release is not null");
+ return store.releaseToGlobalPool(release);
+ }
+
+ @Override
+ public boolean isDevicePoolFull(DeviceId deviceId) {
+ checkNotNull(deviceId, "deviceId is not null");
+ return store.isDevicePoolFull(deviceId);
+ }
+
+ @Override
+ public boolean isGlobalPoolFull() {
+ return store.isGlobalPoolFull();
+ }
+
+ @Override
+ public long getFreeNumOfDevicePool(DeviceId deviceId) {
+ checkNotNull(deviceId, "deviceId is not null");
+ return store.getFreeNumOfDevicePool(deviceId);
+ }
+
+ @Override
+ public long getFreeNumOfGlobalPool() {
+ return store.getFreeNumOfGlobalPool();
+ }
+
+ @Override
+ public LabelResourcePool getDeviceLabelResourcePool(DeviceId deviceId) {
+ checkNotNull(deviceId, "deviceId is not null");
+ return store.getDeviceLabelResourcePool(deviceId);
+ }
+
+ @Override
+ public LabelResourcePool getGlobalLabelResourcePool() {
+ return store.getGlobalLabelResourcePool();
+ }
+
+ private class InternalLabelResourceDelegate implements LabelResourceDelegate {
+ @Override
+ public void notify(LabelResourceEvent event) {
+ post(event);
+ }
+
+ }
+
+ private class InternalDeviceListener implements DeviceListener {
+ @Override
+ public void event(DeviceEvent event) {
+ Device device = event.subject();
+ if (Type.DEVICE_REMOVED.equals(event.type())) {
+ destroyDevicePool(device.id());
+ }
+ }
+ }
+
+ private class InternalLabelResourceProviderService
+ extends AbstractProviderService<LabelResourceProvider>
+ implements LabelResourceProviderService {
+
+ protected InternalLabelResourceProviderService(LabelResourceProvider provider) {
+ super(provider);
+ }
+
+ @Override
+ public void deviceLabelResourcePoolDetected(DeviceId deviceId,
+ LabelResourceId beginLabel,
+ LabelResourceId endLabel) {
+ checkNotNull(deviceId, "deviceId is not null");
+ checkNotNull(beginLabel, "beginLabel is not null");
+ checkNotNull(endLabel, "endLabel is not null");
+ createDevicePool(deviceId, beginLabel, endLabel);
+ }
+
+ @Override
+ public void deviceLabelResourcePoolDestroyed(DeviceId deviceId) {
+ checkNotNull(deviceId, "deviceId is not null");
+ destroyDevicePool(deviceId);
+ }
+
+ }
+
+ @Override
+ protected LabelResourceProviderService createProviderService(LabelResourceProvider provider) {
+ return new InternalLabelResourceProviderService(provider);
+ }
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/impl/package-info.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/impl/package-info.java
new file mode 100644
index 0000000..6df566f
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/impl/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2015-present Open Networking Foundation
+ *
+ * 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.
+ */
+
+/**
+ * Implementation of the label resource subsystem.
+ */
+package org.onosproject.incubator.net.resource.label.impl;
\ No newline at end of file
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/store/impl/DistributedLabelResourceStore.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/store/impl/DistributedLabelResourceStore.java
new file mode 100644
index 0000000..aa7133a
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/store/impl/DistributedLabelResourceStore.java
@@ -0,0 +1,530 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label.store.impl;
+
+import com.google.common.collect.ImmutableSet;
+import com.google.common.collect.Multimap;
+import org.onlab.util.KryoNamespace;
+import org.onosproject.cluster.ClusterService;
+import org.onosproject.cluster.NodeId;
+import org.onosproject.incubator.net.resource.label.DefaultLabelResource;
+import org.onosproject.incubator.net.resource.label.LabelResource;
+import org.onosproject.incubator.net.resource.label.LabelResourceDelegate;
+import org.onosproject.incubator.net.resource.label.LabelResourceEvent;
+import org.onosproject.incubator.net.resource.label.LabelResourceEvent.Type;
+import org.onosproject.incubator.net.resource.label.LabelResourceId;
+import org.onosproject.incubator.net.resource.label.LabelResourcePool;
+import org.onosproject.incubator.net.resource.label.LabelResourceRequest;
+import org.onosproject.incubator.net.resource.label.LabelResourceStore;
+import org.onosproject.mastership.MastershipService;
+import org.onosproject.net.Device;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.device.DeviceService;
+import org.onosproject.store.AbstractStore;
+import org.onosproject.store.cluster.messaging.ClusterCommunicationService;
+import org.onosproject.store.serializers.KryoNamespaces;
+import org.onosproject.store.service.ConsistentMap;
+import org.onosproject.store.service.Serializer;
+import org.onosproject.store.service.StorageService;
+import org.onosproject.store.service.Versioned;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Deactivate;
+import org.osgi.service.component.annotations.Reference;
+import org.osgi.service.component.annotations.ReferenceCardinality;
+import org.slf4j.Logger;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.Future;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+
+import static org.onlab.util.Tools.groupedThreads;
+import static org.slf4j.LoggerFactory.getLogger;
+
+/**
+ * Manages label resources using copycat.
+ */
+@Component(immediate = true, service = LabelResourceStore.class)
+public class DistributedLabelResourceStore
+ extends AbstractStore<LabelResourceEvent, LabelResourceDelegate>
+ implements LabelResourceStore {
+ private final Logger log = getLogger(getClass());
+
+ private static final String POOL_MAP_NAME = "onos-label-resource-pool";
+
+ private static final String GLOBAL_RESOURCE_POOL_DEVICE_ID = "global_resource_pool_device_id";
+
+ private ConsistentMap<DeviceId, LabelResourcePool> resourcePool = null;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY)
+ protected StorageService storageService;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY)
+ protected MastershipService mastershipService;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY)
+ protected ClusterCommunicationService clusterCommunicator;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY)
+ protected ClusterService clusterService;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY)
+ protected DeviceService deviceService;
+
+ private ExecutorService messageHandlingExecutor;
+ private static final int MESSAGE_HANDLER_THREAD_POOL_SIZE = 8;
+ private static final long PEER_REQUEST_TIMEOUT_MS = 5000;
+
+ private static final Serializer SERIALIZER = Serializer
+ .using(new KryoNamespace.Builder().register(KryoNamespaces.API)
+ .register(LabelResourceEvent.class)
+ .register(LabelResourcePool.class)
+ .register(LabelResourceRequest.class)
+ .register(LabelResourceRequest.Type.class)
+ .register(LabelResourceEvent.Type.class)
+ .register(DefaultLabelResource.class)
+ .register(LabelResourceId.class)
+ .nextId(KryoNamespaces.BEGIN_USER_CUSTOM_ID).build());
+
+ @Activate
+ public void activate() {
+
+ resourcePool = storageService
+ .<DeviceId, LabelResourcePool>consistentMapBuilder()
+ .withName(POOL_MAP_NAME).withSerializer(SERIALIZER).build();
+ messageHandlingExecutor = Executors
+ .newFixedThreadPool(MESSAGE_HANDLER_THREAD_POOL_SIZE,
+ groupedThreads("onos/store/flow",
+ "message-handlers",
+ log));
+ clusterCommunicator
+ .addSubscriber(LabelResourceMessageSubjects.LABEL_POOL_CREATED,
+ SERIALIZER::<LabelResourcePool>decode,
+ operation -> {
+ log.trace("received get flow entry request for {}", operation);
+ return internalCreate(operation);
+ },
+ SERIALIZER::<Boolean>encode,
+ messageHandlingExecutor);
+ clusterCommunicator
+ .addSubscriber(LabelResourceMessageSubjects.LABEL_POOL_DESTROYED,
+ SERIALIZER::<DeviceId>decode,
+ deviceId -> {
+ log.trace("received get flow entry request for {}", deviceId);
+ return internalDestroy(deviceId);
+ },
+ SERIALIZER::<Boolean>encode,
+ messageHandlingExecutor);
+ clusterCommunicator
+ .addSubscriber(LabelResourceMessageSubjects.LABEL_POOL_APPLY,
+ SERIALIZER::<LabelResourceRequest>decode,
+ request -> {
+ log.trace("received get flow entry request for {}", request);
+ return internalApply(request);
+
+ },
+ SERIALIZER::<Collection<LabelResource>>encode,
+ messageHandlingExecutor);
+ clusterCommunicator
+ .addSubscriber(LabelResourceMessageSubjects.LABEL_POOL_RELEASE,
+ SERIALIZER::<LabelResourceRequest>decode,
+ request -> {
+ log.trace("received get flow entry request for {}",
+ request);
+ return internalRelease(request);
+ },
+ SERIALIZER::<Boolean>encode,
+ messageHandlingExecutor);
+ log.info("Started");
+ }
+
+ @Deactivate
+ public void deactivate() {
+ clusterCommunicator
+ .removeSubscriber(LabelResourceMessageSubjects.LABEL_POOL_CREATED);
+ clusterCommunicator
+ .removeSubscriber(LabelResourceMessageSubjects.LABEL_POOL_APPLY);
+ clusterCommunicator
+ .removeSubscriber(LabelResourceMessageSubjects.LABEL_POOL_DESTROYED);
+ clusterCommunicator
+ .removeSubscriber(LabelResourceMessageSubjects.LABEL_POOL_RELEASE);
+ messageHandlingExecutor.shutdown();
+ log.info("Stopped");
+ }
+
+ @Override
+ public boolean createDevicePool(DeviceId deviceId,
+ LabelResourceId beginLabel,
+ LabelResourceId endLabel) {
+ LabelResourcePool pool = new LabelResourcePool(deviceId.toString(),
+ beginLabel.labelId(),
+ endLabel.labelId());
+ return this.create(pool);
+ }
+
+ @Override
+ public boolean createGlobalPool(LabelResourceId beginLabel,
+ LabelResourceId endLabel) {
+ LabelResourcePool pool = new LabelResourcePool(GLOBAL_RESOURCE_POOL_DEVICE_ID,
+ beginLabel.labelId(),
+ endLabel.labelId());
+ return this.internalCreate(pool);
+ }
+
+ private boolean create(LabelResourcePool pool) {
+ Device device = deviceService.getDevice(pool.deviceId());
+ if (device == null) {
+ return false;
+ }
+
+ NodeId master = mastershipService.getMasterFor(pool.deviceId());
+
+ if (master == null) {
+ log.warn("Failed to create label resource pool: No master for {}", pool);
+ return false;
+ }
+
+ if (master.equals(clusterService.getLocalNode().id())) {
+ return internalCreate(pool);
+ }
+
+ log.trace("Forwarding getFlowEntries to {}, which is the primary (master) for device {}",
+ master, pool.deviceId());
+
+ return complete(clusterCommunicator
+ .sendAndReceive(pool,
+ LabelResourceMessageSubjects.LABEL_POOL_CREATED,
+ SERIALIZER::encode, SERIALIZER::decode,
+ master));
+ }
+
+ private boolean internalCreate(LabelResourcePool pool) {
+ Versioned<LabelResourcePool> poolOld = resourcePool
+ .get(pool.deviceId());
+ if (poolOld == null) {
+ resourcePool.put(pool.deviceId(), pool);
+ LabelResourceEvent event = new LabelResourceEvent(Type.POOL_CREATED,
+ pool);
+ notifyDelegate(event);
+ return true;
+ }
+ return false;
+ }
+
+ @Override
+ public boolean destroyDevicePool(DeviceId deviceId) {
+ Device device = deviceService.getDevice(deviceId);
+ if (device == null) {
+ return false;
+ }
+
+ NodeId master = mastershipService.getMasterFor(deviceId);
+
+ if (master == null) {
+ log.warn("Failed to destroyDevicePool. No master for {}", deviceId);
+ return false;
+ }
+
+ if (master.equals(clusterService.getLocalNode().id())) {
+ return internalDestroy(deviceId);
+ }
+
+ log.trace("Forwarding request to {}, which is the primary (master) for device {}",
+ master, deviceId);
+
+ return complete(clusterCommunicator
+ .sendAndReceive(deviceId,
+ LabelResourceMessageSubjects.LABEL_POOL_DESTROYED,
+ SERIALIZER::encode, SERIALIZER::decode,
+ master));
+ }
+
+ private boolean internalDestroy(DeviceId deviceId) {
+ Versioned<LabelResourcePool> poolOld = resourcePool.get(deviceId);
+ if (poolOld != null) {
+ resourcePool.remove(deviceId);
+ LabelResourceEvent event = new LabelResourceEvent(Type.POOL_DESTROYED,
+ poolOld.value());
+ notifyDelegate(event);
+ }
+ log.info("success to destroy the label resource pool of device id {}",
+ deviceId);
+ return true;
+ }
+
+ @Override
+ public Collection<LabelResource> applyFromDevicePool(DeviceId deviceId,
+ long applyNum) {
+ Device device = deviceService.getDevice(deviceId);
+ if (device == null) {
+ return Collections.emptyList();
+ }
+ LabelResourceRequest request = new LabelResourceRequest(deviceId,
+ LabelResourceRequest.Type.APPLY,
+ applyNum, null);
+ NodeId master = mastershipService.getMasterFor(deviceId);
+
+ if (master == null) {
+ log.warn("Failed to applyFromDevicePool: No master for {}", deviceId);
+ return Collections.emptyList();
+ }
+
+ if (master.equals(clusterService.getLocalNode().id())) {
+ return internalApply(request);
+ }
+
+ log.trace("Forwarding request to {}, which is the primary (master) for device {}",
+ master, deviceId);
+
+ return complete(clusterCommunicator
+ .sendAndReceive(request,
+ LabelResourceMessageSubjects.LABEL_POOL_APPLY,
+ SERIALIZER::encode, SERIALIZER::decode,
+ master));
+ }
+
+ private Collection<LabelResource> internalApply(LabelResourceRequest request) {
+ DeviceId deviceId = request.deviceId();
+ long applyNum = request.applyNum();
+ Versioned<LabelResourcePool> poolOld = resourcePool.get(deviceId);
+ if (poolOld == null) {
+ log.info("label resource pool not allocated for deviceId {}.", deviceId);
+ return Collections.emptyList();
+ }
+ LabelResourcePool pool = poolOld.value();
+ Collection<LabelResource> result = new HashSet<>();
+ long freeNum = this.getFreeNumOfDevicePool(deviceId);
+ if (applyNum > freeNum) {
+ log.info("the free number of the label resource pool of deviceId {} is not enough.");
+ return Collections.emptyList();
+ }
+ Set<LabelResource> releaseLabels = new HashSet<>(pool.releaseLabelId());
+ long tmp = releaseLabels.size() > applyNum ? applyNum : releaseLabels
+ .size();
+ LabelResource resource = null;
+ for (int i = 0; i < tmp; i++) {
+ Iterator<LabelResource> it = releaseLabels.iterator();
+ if (it.hasNext()) {
+ resource = it.next();
+ releaseLabels.remove(resource);
+ }
+ result.add(resource);
+ }
+ for (long j = pool.currentUsedMaxLabelId().labelId(); j < pool
+ .currentUsedMaxLabelId().labelId() + applyNum - tmp; j++) {
+ resource = new DefaultLabelResource(deviceId,
+ LabelResourceId
+ .labelResourceId(j));
+ result.add(resource);
+ }
+ long beginLabel = pool.beginLabel().labelId();
+ long endLabel = pool.endLabel().labelId();
+ long totalNum = pool.totalNum();
+ long current = pool.currentUsedMaxLabelId().labelId() + applyNum - tmp;
+ long usedNum = pool.usedNum() + applyNum;
+ ImmutableSet<LabelResource> freeLabel = ImmutableSet
+ .copyOf(releaseLabels);
+ LabelResourcePool newPool = new LabelResourcePool(deviceId.toString(),
+ beginLabel, endLabel,
+ totalNum, usedNum,
+ current, freeLabel);
+ resourcePool.put(deviceId, newPool);
+ log.info("success to apply label resource");
+ return result;
+ }
+
+ @Override
+ public boolean releaseToDevicePool(Multimap<DeviceId, LabelResource> release) {
+ Map<DeviceId, Collection<LabelResource>> maps = release.asMap();
+ Set<DeviceId> deviceIdSet = maps.keySet();
+ LabelResourceRequest request = null;
+ for (Iterator<DeviceId> it = deviceIdSet.iterator(); it.hasNext();) {
+ DeviceId deviceId = it.next();
+ Device device = deviceService.getDevice(deviceId);
+ if (device == null) {
+ continue;
+ }
+ ImmutableSet<LabelResource> collection = ImmutableSet.copyOf(maps
+ .get(deviceId));
+ request = new LabelResourceRequest(deviceId,
+ LabelResourceRequest.Type.RELEASE,
+ 0, collection);
+ NodeId master = mastershipService.getMasterFor(deviceId);
+
+ if (master == null) {
+ log.warn("Failed to releaseToDevicePool: No master for {}", deviceId);
+ return false;
+ }
+
+ if (master.equals(clusterService.getLocalNode().id())) {
+ return internalRelease(request);
+ }
+
+ log.trace("Forwarding request to {}, which is the primary (master) for device {}",
+ master, deviceId);
+
+ return complete(clusterCommunicator
+ .sendAndReceive(request,
+ LabelResourceMessageSubjects.LABEL_POOL_RELEASE,
+ SERIALIZER::encode, SERIALIZER::decode,
+ master));
+ }
+ return false;
+ }
+
+ private boolean internalRelease(LabelResourceRequest request) {
+ DeviceId deviceId = request.deviceId();
+ Collection<LabelResource> release = request.releaseCollection();
+ Versioned<LabelResourcePool> poolOld = resourcePool.get(deviceId);
+ if (poolOld == null) {
+ log.info("the label resource pool of device id {} not allocated");
+ return false;
+ }
+ LabelResourcePool pool = poolOld.value();
+ if (pool == null) {
+ log.info("the label resource pool of device id {} does not exist");
+ return false;
+ }
+ Set<LabelResource> storeSet = new HashSet<>(pool.releaseLabelId());
+ LabelResource labelResource = null;
+ long realReleasedNum = 0;
+ for (Iterator<LabelResource> it = release.iterator(); it.hasNext();) {
+ labelResource = it.next();
+ if (labelResource.labelResourceId().labelId() < pool.beginLabel()
+ .labelId()
+ || labelResource.labelResourceId().labelId() > pool
+ .endLabel().labelId()) {
+ continue;
+ }
+ if (pool.currentUsedMaxLabelId().labelId() > labelResource
+ .labelResourceId().labelId()
+ || !storeSet.contains(labelResource)) {
+ storeSet.add(labelResource);
+ realReleasedNum++;
+ }
+ }
+ long beginNum = pool.beginLabel().labelId();
+ long endNum = pool.endLabel().labelId();
+ long totalNum = pool.totalNum();
+ long usedNum = pool.usedNum() - realReleasedNum;
+ long current = pool.currentUsedMaxLabelId().labelId();
+ ImmutableSet<LabelResource> s = ImmutableSet.copyOf(storeSet);
+ LabelResourcePool newPool = new LabelResourcePool(deviceId.toString(),
+ beginNum, endNum,
+ totalNum, usedNum,
+ current, s);
+ resourcePool.put(deviceId, newPool);
+ log.info("success to release label resource");
+ return true;
+ }
+
+ @Override
+ public boolean isDevicePoolFull(DeviceId deviceId) {
+ Versioned<LabelResourcePool> pool = resourcePool.get(deviceId);
+ if (pool == null) {
+ return true;
+ }
+ return pool.value().currentUsedMaxLabelId() == pool.value().endLabel()
+ && pool.value().releaseLabelId().size() == 0 ? true : false;
+ }
+
+ @Override
+ public long getFreeNumOfDevicePool(DeviceId deviceId) {
+ Versioned<LabelResourcePool> pool = resourcePool.get(deviceId);
+ if (pool == null) {
+ return 0;
+ }
+ return pool.value().endLabel().labelId()
+ - pool.value().currentUsedMaxLabelId().labelId()
+ + pool.value().releaseLabelId().size();
+ }
+
+ @Override
+ public LabelResourcePool getDeviceLabelResourcePool(DeviceId deviceId) {
+ Versioned<LabelResourcePool> pool = resourcePool.get(deviceId);
+ return pool == null ? null : pool.value();
+ }
+
+ @Override
+ public boolean destroyGlobalPool() {
+ return this.internalDestroy(DeviceId
+ .deviceId(GLOBAL_RESOURCE_POOL_DEVICE_ID));
+ }
+
+ @Override
+ public Collection<LabelResource> applyFromGlobalPool(long applyNum) {
+ LabelResourceRequest request = new LabelResourceRequest(DeviceId.deviceId(GLOBAL_RESOURCE_POOL_DEVICE_ID),
+ LabelResourceRequest.Type.APPLY,
+ applyNum, null);
+ return this.internalApply(request);
+ }
+
+ @Override
+ public boolean releaseToGlobalPool(Set<LabelResourceId> release) {
+ Set<LabelResource> set = new HashSet<>();
+ DefaultLabelResource resource = null;
+ for (LabelResourceId labelResource : release) {
+ resource = new DefaultLabelResource(DeviceId.deviceId(GLOBAL_RESOURCE_POOL_DEVICE_ID),
+ labelResource);
+ set.add(resource);
+ }
+ LabelResourceRequest request = new LabelResourceRequest(DeviceId.deviceId(GLOBAL_RESOURCE_POOL_DEVICE_ID),
+ LabelResourceRequest.Type.RELEASE,
+ 0,
+ ImmutableSet.copyOf(set));
+ return this.internalRelease(request);
+ }
+
+ @Override
+ public boolean isGlobalPoolFull() {
+ return this.isDevicePoolFull(DeviceId
+ .deviceId(GLOBAL_RESOURCE_POOL_DEVICE_ID));
+ }
+
+ @Override
+ public long getFreeNumOfGlobalPool() {
+ return this.getFreeNumOfDevicePool(DeviceId
+ .deviceId(GLOBAL_RESOURCE_POOL_DEVICE_ID));
+ }
+
+ @Override
+ public LabelResourcePool getGlobalLabelResourcePool() {
+ return this.getDeviceLabelResourcePool(DeviceId
+ .deviceId(GLOBAL_RESOURCE_POOL_DEVICE_ID));
+ }
+
+ private <T> T complete(Future<T> future) {
+ try {
+ return future.get(PEER_REQUEST_TIMEOUT_MS, TimeUnit.MILLISECONDS);
+ } catch (InterruptedException e) {
+ Thread.currentThread().interrupt();
+ log.error("Interrupted while waiting for operation to complete.", e);
+ return null;
+ } catch (TimeoutException | ExecutionException e) {
+ log.error("Failed remote operation", e);
+ return null;
+ }
+ }
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/store/impl/LabelResourceMessageSubjects.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/store/impl/LabelResourceMessageSubjects.java
new file mode 100644
index 0000000..cd89233
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/store/impl/LabelResourceMessageSubjects.java
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.resource.label.store.impl;
+
+import org.onosproject.store.cluster.messaging.MessageSubject;
+
+public final class LabelResourceMessageSubjects {
+
+ private LabelResourceMessageSubjects() {
+ }
+ public static final MessageSubject LABEL_POOL_CREATED
+ = new MessageSubject("label-resource-pool-created");
+ public static final MessageSubject LABEL_POOL_DESTROYED
+ = new MessageSubject("label-resource-pool-destroyed");
+ public static final MessageSubject LABEL_POOL_APPLY
+ = new MessageSubject("label-resource-pool-apply");
+ public static final MessageSubject LABEL_POOL_RELEASE
+ = new MessageSubject("label-resource-pool-release");
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/store/impl/package-info.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/store/impl/package-info.java
new file mode 100644
index 0000000..b97e9bc
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/resource/label/store/impl/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.
+ */
+
+/**
+ * Implementation of the label resource distributed store.
+ */
+package org.onosproject.incubator.net.resource.label.store.impl;
\ No newline at end of file
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/AddTunnelCommand.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/AddTunnelCommand.java
new file mode 100644
index 0000000..86eb5f4
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/AddTunnelCommand.java
@@ -0,0 +1,69 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel.cli;
+
+import org.apache.karaf.shell.api.action.Argument;
+import org.apache.karaf.shell.api.action.Command;
+import org.apache.karaf.shell.api.action.lifecycle.Service;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.incubator.net.domain.IntentDomainId;
+import org.onosproject.incubator.net.domain.IntentDomainService;
+import org.onosproject.incubator.net.domain.TunnelPrimitive;
+import org.onosproject.net.ConnectPoint;
+
+import java.util.NoSuchElementException;
+
+/**
+ * Installs intent domain tunnel primitive.
+ */
+@Service
+@Command(scope = "onos", name = "add-domain-tunnel",
+ description = "Installs intent domain tunnel primitive")
+public class AddTunnelCommand extends AbstractShellCommand {
+
+ @Argument(index = 0, name = "one",
+ description = "Port one",
+ required = true, multiValued = false)
+ String oneString = null;
+
+ @Argument(index = 1, name = "two",
+ description = "Port two",
+ required = true, multiValued = false)
+ String twoString = null;
+
+ @Override
+ protected void doExecute() {
+ IntentDomainService service = get(IntentDomainService.class);
+
+ ConnectPoint one = ConnectPoint.deviceConnectPoint(oneString);
+ ConnectPoint two = ConnectPoint.deviceConnectPoint(twoString);
+
+ TunnelPrimitive tunnel = new TunnelPrimitive(appId(), one, two);
+
+ // get the first domain (there should only be one)
+ final IntentDomainId domainId;
+ try {
+ domainId = service.getDomains().iterator().next().id();
+ } catch (NoSuchElementException | NullPointerException e) {
+ print("No domains found");
+ return;
+ }
+
+ service.request(domainId, tunnel).forEach(r -> service.submit(domainId, r));
+
+ print("Intent domain tunnel submitted:\n%s", tunnel);
+ }
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelBorrowCommand.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelBorrowCommand.java
new file mode 100644
index 0000000..4934c11
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelBorrowCommand.java
@@ -0,0 +1,214 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel.cli;
+
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.Optional;
+
+import org.apache.karaf.shell.api.action.Argument;
+import org.apache.karaf.shell.api.action.Command;
+import org.apache.karaf.shell.api.action.lifecycle.Service;
+import org.apache.karaf.shell.api.action.Option;
+import org.onlab.packet.IpAddress;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.core.DefaultApplicationId;
+import org.onosproject.incubator.net.tunnel.DefaultOpticalTunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.IpTunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.OpticalLogicId;
+import org.onosproject.incubator.net.tunnel.OpticalTunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.Tunnel;
+import org.onosproject.incubator.net.tunnel.TunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.TunnelId;
+import org.onosproject.incubator.net.tunnel.TunnelName;
+import org.onosproject.incubator.net.tunnel.TunnelService;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.PortNumber;
+import org.onosproject.net.provider.ProviderId;
+
+/**
+ * Borrows tunnels. It's used by consumers.
+ */
+@Service
+@Command(scope = "onos", name = "tunnel-borrow", description = "Borrows tunnels. It's used by consumers.")
+public class TunnelBorrowCommand extends AbstractShellCommand {
+
+ @Argument(index = 0, name = "consumerId",
+ description = "consumer id means application id.", required = true, multiValued = false)
+ String consumerId = null;
+
+ @Option(name = "-s", aliases = "--src", description = "Source tunnel point."
+ + " Only supports for IpTunnelEndPoint and OpticalTunnelEndPoint as end point now."
+ + " If deletess a ODUK or OCH type tunnel, the formatter of this argument is DeviceId-PortNumber."
+ + " Otherwise src means IP address.", required = false, multiValued = false)
+ String src = null;
+
+ @Option(name = "-d", aliases = "--dst", description = "Destination tunnel point."
+ + " Only supports for IpTunnelEndPoint and OpticalTunnelEndPoint as end point now."
+ + " If deletess a ODUK or OCH type tunnel, the formatter of this argument is DeviceId-PortNumber."
+ + " Otherwise dst means IP address.", required = false, multiValued = false)
+ String dst = null;
+
+ @Option(name = "-t", aliases = "--type", description = "The type of tunnels,"
+ + " It includes MPLS, VLAN, VXLAN, GRE, ODUK, OCH", required = false, multiValued = false)
+ String type = null;
+
+ @Option(name = "-i", aliases = "--tunnelId",
+ description = "the tunnel identity.", required = false, multiValued = false)
+ String tunnelId = null;
+
+ @Option(name = "-n", aliases = "--tunnelName",
+ description = "The name of tunnels", required = false, multiValued = false)
+ String tunnelName = null;
+ private static final String FMT = "src=%s, dst=%s,"
+ + "type=%s, state=%s, producerName=%s, tunnelName=%s,"
+ + "groupId=%s";
+
+ @Override
+ protected void doExecute() {
+ Collection<Tunnel> tunnelSet = null;
+ Tunnel.Type trueType = null;
+ TunnelService service = get(TunnelService.class);
+ ApplicationId appId = new DefaultApplicationId(1, consumerId);
+ ProviderId producerName = new ProviderId("default",
+ "org.onosproject.provider.tunnel.default");
+ if (!isNull(src) && !isNull(dst) && !isNull(type)) {
+ TunnelEndPoint srcPoint = null;
+ TunnelEndPoint dstPoint = null;
+ if ("MPLS".equals(type)) {
+ trueType = Tunnel.Type.MPLS;
+ srcPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(src));
+ dstPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(dst));
+ } else if ("VXLAN".equals(type)) {
+ trueType = Tunnel.Type.VXLAN;
+ srcPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(src));
+ dstPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(dst));
+ } else if ("GRE".equals(type)) {
+ trueType = Tunnel.Type.GRE;
+ srcPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(src));
+ dstPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(dst));
+ } else if ("VLAN".equals(type)) {
+ trueType = Tunnel.Type.VLAN;
+ String[] srcArray = src.split("-");
+ String[] dstArray = dst.split("-");
+ srcPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(srcArray[0])),
+ Optional.of(PortNumber
+ .portNumber(srcArray[1])),
+ null,
+ null,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ dstPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(dstArray[0])),
+ Optional.of(PortNumber
+ .portNumber(dstArray[1])),
+ null,
+ null,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ } else if ("ODUK".equals(type)) {
+ trueType = Tunnel.Type.ODUK;
+ String[] srcArray = src.split("-");
+ String[] dstArray = dst.split("-");
+ srcPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(srcArray[0])),
+ Optional.of(PortNumber
+ .portNumber(srcArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.LAMBDA,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ dstPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(dstArray[0])),
+ Optional.of(PortNumber
+ .portNumber(dstArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.LAMBDA,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ } else if ("OCH".equals(type)) {
+ trueType = Tunnel.Type.OCH;
+ String[] srcArray = src.split("-");
+ String[] dstArray = dst.split("-");
+ srcPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(srcArray[0])),
+ Optional.of(PortNumber
+ .portNumber(srcArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.TIMESLOT,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ dstPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(dstArray[0])),
+ Optional.of(PortNumber
+ .portNumber(dstArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.TIMESLOT,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ } else {
+ print("Illegal tunnel type. Please input MPLS, VLAN, VXLAN, GRE, ODUK or OCH.");
+ return;
+ }
+ tunnelSet = service.borrowTunnel(appId, srcPoint, dstPoint, trueType);
+ }
+ if (!isNull(tunnelId)) {
+ TunnelId id = TunnelId.valueOf(tunnelId);
+ Tunnel tunnel = service.borrowTunnel(appId, id);
+ tunnelSet = new HashSet<Tunnel>();
+ tunnelSet.add(tunnel);
+ }
+ if (!isNull(tunnelName)) {
+ TunnelName name = TunnelName.tunnelName(tunnelName);
+ tunnelSet = service.borrowTunnel(appId, name);
+ }
+ for (Tunnel tunnel : tunnelSet) {
+ print(FMT, tunnel.src(), tunnel.dst(), tunnel.type(),
+ tunnel.state(), tunnel.providerId(), tunnel.tunnelName(),
+ tunnel.groupId());
+ }
+ }
+
+ private boolean isNull(String s) {
+ return s == null || "".equals(s);
+ }
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelCreateCommand.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelCreateCommand.java
new file mode 100644
index 0000000..259998a
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelCreateCommand.java
@@ -0,0 +1,207 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel.cli;
+
+import java.util.Optional;
+
+import org.apache.karaf.shell.api.action.Argument;
+import org.apache.karaf.shell.api.action.Command;
+import org.apache.karaf.shell.api.action.lifecycle.Service;
+import org.apache.karaf.shell.api.action.Option;
+import org.onlab.packet.IpAddress;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.core.GroupId;
+import org.onosproject.incubator.net.tunnel.DefaultOpticalTunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.DefaultTunnelDescription;
+import org.onosproject.incubator.net.tunnel.IpTunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.OpticalLogicId;
+import org.onosproject.incubator.net.tunnel.OpticalTunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.Tunnel;
+import org.onosproject.incubator.net.tunnel.TunnelDescription;
+import org.onosproject.incubator.net.tunnel.TunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.TunnelId;
+import org.onosproject.incubator.net.tunnel.TunnelName;
+import org.onosproject.incubator.net.tunnel.TunnelProvider;
+import org.onosproject.net.DefaultAnnotations;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.PortNumber;
+import org.onosproject.net.SparseAnnotations;
+import org.onosproject.net.provider.ProviderId;
+
+/**
+ * Supports for creating a tunnel by using IP address and optical as tunnel end
+ * point.
+ */
+@Service
+@Command(scope = "onos", name = "tunnel-create",
+description = "Supports for creating a tunnel by using IP address and optical as tunnel end point now.")
+public class TunnelCreateCommand extends AbstractShellCommand {
+
+ @Argument(index = 0, name = "src", description = "Source tunnel point."
+ + " Only supports for IpTunnelEndPoint and OpticalTunnelEndPoint as end point now."
+ + " If creates a ODUK or OCH or VLAN type tunnel, the formatter of this argument is DeviceId-PortNumber."
+ + " Otherwise src means IP address.", required = true, multiValued = false)
+ String src = null;
+
+ @Argument(index = 1, name = "dst", description = "Destination tunnel point."
+ + " Only supports for IpTunnelEndPoint and OpticalTunnelEndPoint as end point now."
+ + " If creates a ODUK or OCH or VLAN type tunnel, the formatter of this argument is DeviceId-PortNumber."
+ + " Otherwise dst means IP address.", required = true, multiValued = false)
+ String dst = null;
+ @Argument(index = 2, name = "type", description = "The type of tunnels,"
+ + " It includes MPLS, VLAN, VXLAN, GRE, ODUK, OCH", required = true, multiValued = false)
+ String type = null;
+ @Option(name = "-g", aliases = "--groupId",
+ description = "Group flow table id which a tunnel match up", required = false, multiValued = false)
+ String groupId = "0";
+
+ @Option(name = "-n", aliases = "--tunnelName",
+ description = "The name of tunnels", required = false, multiValued = false)
+ String tunnelName = "onos";
+
+ @Option(name = "-b", aliases = "--bandwidth",
+ description = "The bandwidth attribute of tunnel", required = false, multiValued = false)
+ String bandwidth = "1024";
+
+ private static final String FMT = "The tunnel identity is %s";
+
+ @Override
+ protected void doExecute() {
+ TunnelProvider service = get(TunnelProvider.class);
+ ProviderId producerName = new ProviderId("default",
+ "org.onosproject.provider.tunnel.default");
+ TunnelEndPoint srcPoint = null;
+ TunnelEndPoint dstPoint = null;
+ Tunnel.Type trueType = null;
+ if ("MPLS".equals(type)) {
+ trueType = Tunnel.Type.MPLS;
+ srcPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress.valueOf(src));
+ dstPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress.valueOf(dst));
+ } else if ("VLAN".equals(type)) {
+ trueType = Tunnel.Type.VLAN;
+ String[] srcArray = src.split("/");
+ String[] dstArray = dst.split("/");
+ srcPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(srcArray[0])),
+ Optional.of(PortNumber
+ .portNumber(srcArray[1])),
+ null,
+ null,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ dstPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(dstArray[0])),
+ Optional.of(PortNumber
+ .portNumber(dstArray[1])),
+ null,
+ null,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ } else if ("VXLAN".equals(type)) {
+ trueType = Tunnel.Type.VXLAN;
+ srcPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress.valueOf(src));
+ dstPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress.valueOf(dst));
+ } else if ("GRE".equals(type)) {
+ trueType = Tunnel.Type.GRE;
+ srcPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress.valueOf(src));
+ dstPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress.valueOf(dst));
+ } else if ("ODUK".equals(type)) {
+ trueType = Tunnel.Type.ODUK;
+ String[] srcArray = src.split("/");
+ String[] dstArray = dst.split("/");
+ srcPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(srcArray[0])),
+ Optional.of(PortNumber
+ .portNumber(srcArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.LAMBDA,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ dstPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(dstArray[0])),
+ Optional.of(PortNumber
+ .portNumber(dstArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.LAMBDA,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ } else if ("OCH".equals(type)) {
+ trueType = Tunnel.Type.OCH;
+ String[] srcArray = src.split("/");
+ String[] dstArray = dst.split("/");
+ srcPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(srcArray[0])),
+ Optional.of(PortNumber
+ .portNumber(srcArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.TIMESLOT,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ dstPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(dstArray[0])),
+ Optional.of(PortNumber
+ .portNumber(dstArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.TIMESLOT,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ } else {
+ print("Illegal tunnel type. Please input MPLS, VLAN, VXLAN, GRE, ODUK or OCH.");
+ return;
+ }
+
+ SparseAnnotations annotations = DefaultAnnotations
+ .builder()
+ .set("bandwidth", bandwidth == null || "".equals(bandwidth) ? "0" : bandwidth)
+ .build();
+ TunnelDescription tunnel = new DefaultTunnelDescription(
+ null,
+ srcPoint,
+ dstPoint,
+ trueType,
+ new GroupId(Integer.parseInt(groupId)),
+ producerName,
+ TunnelName
+ .tunnelName(tunnelName),
+ null,
+ annotations);
+ TunnelId tunnelId = service.tunnelAdded(tunnel);
+ if (tunnelId == null) {
+ error("Create tunnel failed.");
+ return;
+ }
+ print(FMT, tunnelId.id());
+ }
+
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelQueryCommand.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelQueryCommand.java
new file mode 100644
index 0000000..166929b
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelQueryCommand.java
@@ -0,0 +1,226 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel.cli;
+
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.Optional;
+
+import org.apache.karaf.shell.api.action.Command;
+import org.apache.karaf.shell.api.action.lifecycle.Service;
+import org.apache.karaf.shell.api.action.Option;
+import org.onlab.packet.IpAddress;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.incubator.net.tunnel.DefaultOpticalTunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.IpTunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.OpticalLogicId;
+import org.onosproject.incubator.net.tunnel.OpticalTunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.Tunnel;
+import org.onosproject.incubator.net.tunnel.TunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.TunnelId;
+import org.onosproject.incubator.net.tunnel.TunnelService;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.Link;
+import org.onosproject.net.Path;
+import org.onosproject.net.PortNumber;
+import org.onosproject.net.provider.ProviderId;
+
+/**
+ * Supports for querying tunnels. It's used by consumers.
+ */
+@Service
+@Command(scope = "onos", name = "tunnels", description = "Supports for querying tunnels."
+ + " It's used by consumers.")
+public class TunnelQueryCommand extends AbstractShellCommand {
+ @Option(name = "-s", aliases = "--src", description = "Source tunnel point."
+ + " Only supports for IpTunnelEndPoint and OpticalTunnelEndPoint as end point now."
+ + " If deletess a ODUK or OCH type tunnel, the formatter of this argument is DeviceId-PortNumber."
+ + " Otherwise src means IP address.", required = false, multiValued = false)
+ String src = null;
+ @Option(name = "-d", aliases = "--dst", description = "Destination tunnel point."
+ + " Only supports for IpTunnelEndPoint and OpticalTunnelEndPoint as end point now."
+ + " If deletess a ODUK or OCH type tunnel, the formatter of this argument is DeviceId-PortNumber."
+ + " Otherwise dst means IP address.", required = false, multiValued = false)
+ String dst = null;
+
+ @Option(name = "-t", aliases = "--type", description = "The type of tunnels,"
+ + " It includes MPLS, VLAN, VXLAN, GRE, ODUK, OCH", required = false, multiValued = false)
+ String type = null;
+
+ @Option(name = "-i", aliases = "--tunnelId",
+ description = "the tunnel identity.", required = false, multiValued = false)
+ String tunnelId = null;
+
+ private static final String FMT = "tunnelId=%s, src=%s, dst=%s,"
+ + "type=%s, state=%s, producerName=%s, tunnelName=%s,"
+ + "groupId=%s, path=%s%s";
+
+ @Override
+ protected void doExecute() {
+ Tunnel.Type trueType = null;
+ TunnelService service = get(TunnelService.class);
+ ProviderId producerName = new ProviderId("default",
+ "org.onosproject.provider.tunnel.default");
+ Collection<Tunnel> tunnelSet = null;
+ if (isNull(src) && isNull(dst) && isNull(type) && isNull(tunnelId)) {
+ tunnelSet = service.queryAllTunnels();
+ }
+
+ if (!isNull(src) && !isNull(dst) && !isNull(type)) {
+ TunnelEndPoint srcPoint = null;
+ TunnelEndPoint dstPoint = null;
+ if ("MPLS".equals(type) || "VXLAN".equals(type)
+ || "GRE".equals(type)) {
+ srcPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(src));
+ dstPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(dst));
+ } else if ("VLAN".equals(type)) {
+ String[] srcArray = src.split("/");
+ String[] dstArray = dst.split("/");
+ srcPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(srcArray[0])),
+ Optional.of(PortNumber
+ .portNumber(srcArray[1])),
+ null,
+ null,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ dstPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(dstArray[0])),
+ Optional.of(PortNumber
+ .portNumber(dstArray[1])),
+ null,
+ null,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ } else if ("ODUK".equals(type)) {
+ String[] srcArray = src.split("/");
+ String[] dstArray = dst.split("/");
+ srcPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(srcArray[0])),
+ Optional.of(PortNumber
+ .portNumber(srcArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.LAMBDA,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ dstPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(dstArray[0])),
+ Optional.of(PortNumber
+ .portNumber(dstArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.LAMBDA,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ } else if ("OCH".equals(type)) {
+ String[] srcArray = src.split("/");
+ String[] dstArray = dst.split("/");
+ srcPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(srcArray[0])),
+ Optional.of(PortNumber
+ .portNumber(srcArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.TIMESLOT,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ dstPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(dstArray[0])),
+ Optional.of(PortNumber
+ .portNumber(dstArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.TIMESLOT,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ } else {
+ print("Illegal tunnel type. Please input MPLS, VLAN, VXLAN, GRE, ODUK or OCH.");
+ return;
+ }
+ tunnelSet = service.queryTunnel(srcPoint, dstPoint);
+ }
+ if (!isNull(type)) {
+ if ("MPLS".equals(type)) {
+ trueType = Tunnel.Type.MPLS;
+ } else if ("VLAN".equals(type)) {
+ trueType = Tunnel.Type.VLAN;
+ } else if ("VXLAN".equals(type)) {
+ trueType = Tunnel.Type.VXLAN;
+ } else if ("GRE".equals(type)) {
+ trueType = Tunnel.Type.GRE;
+ } else if ("ODUK".equals(type)) {
+ trueType = Tunnel.Type.ODUK;
+ } else if ("OCH".equals(type)) {
+ trueType = Tunnel.Type.OCH;
+ } else {
+ print("Illegal tunnel type. Please input MPLS, VLAN, VXLAN, GRE, ODUK or OCH.");
+ return;
+ }
+ tunnelSet = service.queryTunnel(trueType);
+ }
+ if (!isNull(tunnelId)) {
+ TunnelId id = TunnelId.valueOf(tunnelId);
+ Tunnel tunnel = service.queryTunnel(id);
+ tunnelSet = new HashSet<Tunnel>();
+ tunnelSet.add(tunnel);
+ }
+ if (tunnelSet != null) {
+ for (Tunnel tunnel : tunnelSet) {
+ print(FMT, tunnel.tunnelId().id(), tunnel.src().toString(), tunnel.dst().toString(),
+ tunnel.type(), tunnel.state(), tunnel.providerId(),
+ tunnel.tunnelName(), tunnel.groupId(),
+ showPath(tunnel.path()),
+ annotations(tunnel.annotations()));
+ }
+ }
+ }
+
+ private String showPath(Path path) {
+ if (path == null) {
+ return "null";
+ }
+ StringBuilder builder = new StringBuilder("(");
+ for (Link link : path.links()) {
+ builder.append("(DeviceId:" + link.src().deviceId() + " Port:"
+ + link.src().port().toString());
+ builder.append(" DeviceId:" + link.dst().deviceId() + " Port:"
+ + link.dst().port().toString() + ")");
+ }
+ builder.append(annotations(path.annotations()) + ")");
+ return builder.toString();
+ }
+
+ private boolean isNull(String s) {
+ return s == null || "".equals(s);
+ }
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelQuerySubscriptionCommand.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelQuerySubscriptionCommand.java
new file mode 100644
index 0000000..bc6df51
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelQuerySubscriptionCommand.java
@@ -0,0 +1,55 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel.cli;
+
+import java.util.Collection;
+
+import org.apache.karaf.shell.api.action.Argument;
+import org.apache.karaf.shell.api.action.Command;
+import org.apache.karaf.shell.api.action.lifecycle.Service;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.core.DefaultApplicationId;
+import org.onosproject.incubator.net.tunnel.TunnelService;
+import org.onosproject.incubator.net.tunnel.TunnelSubscription;
+
+/**
+ * Query all tunnel subscriptions of consumer by consumer id.
+ * It's used by consumers.
+ */
+@Service
+@Command(scope = "onos", name = "tunnel-subscriptions",
+ description = "Query all request orders of consumer by consumer id. It's used by consumers.")
+public class TunnelQuerySubscriptionCommand extends AbstractShellCommand {
+ @Argument(index = 0, name = "consumerId",
+ description = "consumer id means provider id",
+ required = true, multiValued = false)
+ String consumerId = null;
+ private static final String FMT = "appId=%s, src=%s, dst=%s,"
+ + "type=%s, tunnelId=%s";
+
+ @Override
+ protected void doExecute() {
+ TunnelService service = get(TunnelService.class);
+ ApplicationId applicationId = new DefaultApplicationId(1, consumerId);
+ Collection<TunnelSubscription> tunnelSet = service.queryTunnelSubscription(applicationId);
+ for (TunnelSubscription order : tunnelSet) {
+ print(FMT, order.consumerId(), order.src(), order.dst(),
+ order.type(), order.tunnelId());
+ }
+ }
+
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelRemoveCommand.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelRemoveCommand.java
new file mode 100644
index 0000000..446d526
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelRemoveCommand.java
@@ -0,0 +1,205 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel.cli;
+
+import java.util.Collection;
+import java.util.Optional;
+
+import org.apache.karaf.shell.api.action.Command;
+import org.apache.karaf.shell.api.action.lifecycle.Service;
+import org.apache.karaf.shell.api.action.Option;
+import org.onlab.packet.IpAddress;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.incubator.net.tunnel.DefaultOpticalTunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.DefaultTunnelDescription;
+import org.onosproject.incubator.net.tunnel.IpTunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.OpticalLogicId;
+import org.onosproject.incubator.net.tunnel.OpticalTunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.Tunnel;
+import org.onosproject.incubator.net.tunnel.TunnelDescription;
+import org.onosproject.incubator.net.tunnel.TunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.TunnelId;
+import org.onosproject.incubator.net.tunnel.TunnelProvider;
+import org.onosproject.incubator.net.tunnel.TunnelService;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.PortNumber;
+import org.onosproject.net.provider.ProviderId;
+
+/**
+ * Supports for removing tunnels. It's used by producers.
+ */
+@Service
+@Command(scope = "onos", name = "tunnel-remove", description = "Supports for removing tunnels. It's used by producers.")
+public class TunnelRemoveCommand extends AbstractShellCommand {
+ @Option(name = "-s", aliases = "--src", description = "Source tunnel point."
+ + " Only supports for IpTunnelEndPoint and OpticalTunnelEndPoint as end point now."
+ + " If deletess a ODUK or OCH type tunnel, the formatter of this argument is DeviceId-PortNumber."
+ + " Otherwise src means IP address.", required = false, multiValued = false)
+ String src = null;
+ @Option(name = "-d", aliases = "--dst", description = "Destination tunnel point."
+ + " Only supports for IpTunnelEndPoint and OpticalTunnelEndPoint as end point now."
+ + " If deletess a ODUK or OCH type tunnel, the formatter of this argument is DeviceId-PortNumber."
+ + " Otherwise dst means IP address.", required = false, multiValued = false)
+ String dst = null;
+
+ @Option(name = "-t", aliases = "--type", description = "The type of tunnels,"
+ + " It includes MPLS, VLAN, VXLAN, GRE, ODUK, OCH", required = false, multiValued = false)
+ String type = null;
+
+ @Option(name = "-i", aliases = "--tunnelId",
+ description = "the tunnel identity.", required = false, multiValued = false)
+ String tunnelId = null;
+
+ @Override
+ protected void doExecute() {
+ TunnelDescription tunnel = null;
+ TunnelProvider service = get(TunnelProvider.class);
+ ProviderId producerName = new ProviderId("default",
+ "org.onosproject.provider.tunnel.default");
+ if (!isNull(src) && !isNull(dst) && !isNull(type)) {
+ TunnelEndPoint srcPoint = null;
+ TunnelEndPoint dstPoint = null;
+ Tunnel.Type trueType = null;
+ if ("MPLS".equals(type)) {
+ trueType = Tunnel.Type.MPLS;
+ srcPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(src));
+ dstPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(dst));
+ } else if ("VLAN".equals(type)) {
+ trueType = Tunnel.Type.VLAN;
+ srcPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(src));
+ dstPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(dst));
+ } else if ("VXLAN".equals(type)) {
+ trueType = Tunnel.Type.VXLAN;
+ srcPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(src));
+ dstPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(dst));
+ } else if ("GRE".equals(type)) {
+ trueType = Tunnel.Type.GRE;
+ srcPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(src));
+ dstPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(dst));
+ } else if ("ODUK".equals(type)) {
+ trueType = Tunnel.Type.ODUK;
+ String[] srcArray = src.split("/");
+ String[] dstArray = dst.split("/");
+ srcPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(srcArray[0])),
+ Optional.of(PortNumber
+ .portNumber(srcArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.LAMBDA,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ dstPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(dstArray[0])),
+ Optional.of(PortNumber
+ .portNumber(dstArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.LAMBDA,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ } else if ("OCH".equals(type)) {
+ trueType = Tunnel.Type.OCH;
+ String[] srcArray = src.split("/");
+ String[] dstArray = dst.split("/");
+ srcPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(srcArray[0])),
+ Optional.of(PortNumber
+ .portNumber(srcArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.LAMBDA,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ dstPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(dstArray[0])),
+ Optional.of(PortNumber
+ .portNumber(dstArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.LAMBDA,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ } else {
+ print("Illegal tunnel type. Please input MPLS, VLAN, VXLAN, GRE, ODUK or OCH.");
+ return;
+ }
+
+ tunnel = new DefaultTunnelDescription(null, srcPoint, dstPoint,
+ trueType, null, producerName,
+ null, null);
+ service.tunnelRemoved(tunnel);
+ return;
+ }
+ if (!isNull(tunnelId)) {
+ TunnelId id = TunnelId.valueOf(tunnelId);
+ tunnel = new DefaultTunnelDescription(id, null, null, null, null,
+ producerName, null, null);
+ service.tunnelRemoved(tunnel);
+ return;
+ }
+
+ if (!isNull(type)) {
+ Tunnel.Type trueType = null;
+ Collection<Tunnel> tunnelSet = null;
+ TunnelService tunnelService = get(TunnelService.class);
+ if ("MPLS".equals(type)) {
+ trueType = Tunnel.Type.MPLS;
+ } else if ("VLAN".equals(type)) {
+ trueType = Tunnel.Type.VLAN;
+ } else if ("VXLAN".equals(type)) {
+ trueType = Tunnel.Type.VXLAN;
+ } else if ("GRE".equals(type)) {
+ trueType = Tunnel.Type.GRE;
+ } else if ("ODUK".equals(type)) {
+ trueType = Tunnel.Type.ODUK;
+ } else if ("OCH".equals(type)) {
+ trueType = Tunnel.Type.OCH;
+ } else {
+ print("Illegal tunnel type. Please input MPLS, VLAN, VXLAN, GRE, ODUK or OCH.");
+ return;
+ }
+ tunnelSet = tunnelService.queryTunnel(trueType);
+ if (tunnelSet != null) {
+ for (Tunnel tunnelTemp : tunnelSet) {
+ tunnel = new DefaultTunnelDescription(tunnelTemp.tunnelId(), null, null, null, null,
+ producerName, null, null);
+ service.tunnelRemoved(tunnel);
+ }
+ }
+ }
+ }
+
+ private boolean isNull(String s) {
+ return s == null || "".equals(s);
+ }
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelReturnCommand.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelReturnCommand.java
new file mode 100644
index 0000000..ce0f5c3
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelReturnCommand.java
@@ -0,0 +1,200 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel.cli;
+
+import java.util.Optional;
+
+import org.apache.karaf.shell.api.action.Argument;
+import org.apache.karaf.shell.api.action.Command;
+import org.apache.karaf.shell.api.action.lifecycle.Service;
+import org.apache.karaf.shell.api.action.Option;
+import org.onlab.packet.IpAddress;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.core.DefaultApplicationId;
+import org.onosproject.incubator.net.tunnel.DefaultOpticalTunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.IpTunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.OpticalLogicId;
+import org.onosproject.incubator.net.tunnel.OpticalTunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.Tunnel;
+import org.onosproject.incubator.net.tunnel.TunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.TunnelId;
+import org.onosproject.incubator.net.tunnel.TunnelName;
+import org.onosproject.incubator.net.tunnel.TunnelService;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.PortNumber;
+import org.onosproject.net.provider.ProviderId;
+
+/**
+ * Returns tunnels. It's used by consumers.
+ */
+@Service
+@Command(scope = "onos", name = "tunnel-return",
+description = "Returns tunnels. It's used by consumers.")
+public class TunnelReturnCommand extends AbstractShellCommand {
+ @Argument(index = 0, name = "consumerId",
+ description = "consumer id means application id.", required = true, multiValued = false)
+ String consumerId = null;
+
+ @Option(name = "-s", aliases = "--src", description = "Source tunnel point."
+ + " Only supports for IpTunnelEndPoint and OpticalTunnelEndPoint as end point now."
+ + " If deletess a ODUK or OCH type tunnel, the formatter of this argument is DeviceId-PortNumber."
+ + " Otherwise src means IP address.", required = false, multiValued = false)
+ String src = null;
+
+ @Option(name = "-d", aliases = "--dst", description = "Destination tunnel point."
+ + " Only supports for IpTunnelEndPoint and OpticalTunnelEndPoint as end point now."
+ + " If deletess a ODUK or OCH type tunnel, the formatter of this argument is DeviceId-PortNumber."
+ + " Otherwise dst means IP address.", required = false, multiValued = false)
+ String dst = null;
+
+ @Option(name = "-t", aliases = "--type", description = "The type of tunnels,"
+ + " It includes MPLS, VLAN, VXLAN, GRE, ODUK, OCH", required = false, multiValued = false)
+ String type = null;
+
+ @Option(name = "-i", aliases = "--tunnelId",
+ description = "the tunnel identity.", required = false, multiValued = false)
+ String tunnelId = null;
+
+ @Option(name = "-n", aliases = "--tunnelName",
+ description = "The name of tunnels", required = false, multiValued = false)
+ String tunnelName = null;
+
+ @Override
+ protected void doExecute() {
+ Tunnel.Type trueType = null;
+ TunnelService service = get(TunnelService.class);
+ ApplicationId appId = new DefaultApplicationId(1, consumerId);
+ ProviderId producerName = new ProviderId("default",
+ "org.onosproject.provider.tunnel.default");
+ if (!isNull(src) && !isNull(dst) && !isNull(type)) {
+ TunnelEndPoint srcPoint = null;
+ TunnelEndPoint dstPoint = null;
+ if ("MPLS".equals(type)) {
+ trueType = Tunnel.Type.MPLS;
+ srcPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(src));
+ dstPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(dst));
+ } else if ("VXLAN".equals(type)) {
+ trueType = Tunnel.Type.VXLAN;
+ srcPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(src));
+ dstPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(dst));
+ } else if ("GRE".equals(type)) {
+ trueType = Tunnel.Type.GRE;
+ srcPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(src));
+ dstPoint = IpTunnelEndPoint.ipTunnelPoint(IpAddress
+ .valueOf(dst));
+ } else if ("VLAN".equals(type)) {
+ trueType = Tunnel.Type.VLAN;
+ String[] srcArray = src.split("-");
+ String[] dstArray = dst.split("-");
+ srcPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(srcArray[0])),
+ Optional.of(PortNumber
+ .portNumber(srcArray[1])),
+ null,
+ null,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ dstPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(dstArray[0])),
+ Optional.of(PortNumber
+ .portNumber(dstArray[1])),
+ null,
+ null,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ } else if ("ODUK".equals(type)) {
+ trueType = Tunnel.Type.ODUK;
+ String[] srcArray = src.split("-");
+ String[] dstArray = dst.split("-");
+ srcPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(srcArray[0])),
+ Optional.of(PortNumber
+ .portNumber(srcArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.LAMBDA,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ dstPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(dstArray[0])),
+ Optional.of(PortNumber
+ .portNumber(dstArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.LAMBDA,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ } else if ("OCH".equals(type)) {
+ trueType = Tunnel.Type.OCH;
+ String[] srcArray = src.split("-");
+ String[] dstArray = dst.split("-");
+ srcPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(srcArray[0])),
+ Optional.of(PortNumber
+ .portNumber(srcArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.TIMESLOT,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ dstPoint = new DefaultOpticalTunnelEndPoint(
+ producerName,
+ Optional.of(DeviceId
+ .deviceId(dstArray[0])),
+ Optional.of(PortNumber
+ .portNumber(dstArray[1])),
+ null,
+ OpticalTunnelEndPoint.Type.TIMESLOT,
+ OpticalLogicId
+ .logicId(0),
+ true);
+ } else {
+ print("Illegal tunnel type. Please input MPLS, VLAN, VXLAN, GRE, ODUK or OCH.");
+ return;
+ }
+ service.returnTunnel(appId, srcPoint, dstPoint, trueType);
+ }
+ if (!isNull(tunnelId)) {
+ TunnelId id = TunnelId.valueOf(tunnelId);
+ service.returnTunnel(appId, id);
+ }
+ if (!isNull(tunnelName)) {
+ TunnelName name = TunnelName.tunnelName(tunnelName);
+ service.returnTunnel(appId, name);
+ }
+ }
+ private boolean isNull(String s) {
+ return s == null || "".equals(s);
+ }
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelUpdateCommand.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelUpdateCommand.java
new file mode 100644
index 0000000..601281a
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/TunnelUpdateCommand.java
@@ -0,0 +1,63 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel.cli;
+
+import org.apache.karaf.shell.api.action.Argument;
+import org.apache.karaf.shell.api.action.Command;
+import org.apache.karaf.shell.api.action.lifecycle.Service;
+import org.apache.karaf.shell.api.action.Option;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.incubator.net.tunnel.DefaultTunnelDescription;
+import org.onosproject.incubator.net.tunnel.TunnelDescription;
+import org.onosproject.incubator.net.tunnel.TunnelId;
+import org.onosproject.incubator.net.tunnel.TunnelProvider;
+import org.onosproject.net.DefaultAnnotations;
+import org.onosproject.net.SparseAnnotations;
+
+/**
+ * Supports for updating a tunnel by tunnel identity.
+ * It's used by producers.
+ */
+@Service
+@Command(scope = "onos", name = "tunnel-update",
+description = "Supports for updating a tunnel by tunnel identity."
+ + " It's used by producers.")
+public class TunnelUpdateCommand extends AbstractShellCommand {
+ @Argument(index = 0, name = "tunnelId", description = "the tunnel identity.",
+ required = true, multiValued = false)
+ String tunnelId = null;
+
+ @Option(name = "-b", aliases = "--bandwidth",
+ description = "The bandwidth attribute of tunnel", required = false, multiValued = false)
+ String bandwidth = null;
+
+ @Override
+ protected void doExecute() {
+ TunnelProvider service = get(TunnelProvider.class);
+ TunnelId id = TunnelId.valueOf(tunnelId);
+ SparseAnnotations annotations = DefaultAnnotations
+ .builder()
+ .set("bandwidth", bandwidth)
+ .build();
+ TunnelDescription tunnel = new DefaultTunnelDescription(id, null,
+ null,
+ null, null,
+ null,
+ null, null, annotations);
+ service.tunnelUpdated(tunnel);
+ }
+
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/package-info.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/package-info.java
new file mode 100644
index 0000000..8980c62
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/cli/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.
+ */
+
+/**
+ * CLIs for the tunnel subsystem.
+ */
+package org.onosproject.incubator.net.tunnel.cli;
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/impl/TunnelManager.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/impl/TunnelManager.java
new file mode 100644
index 0000000..623d005
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/impl/TunnelManager.java
@@ -0,0 +1,446 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel.impl;
+
+import org.onosproject.core.ApplicationId;
+import org.onosproject.incubator.net.tunnel.DefaultTunnel;
+import org.onosproject.incubator.net.tunnel.Tunnel;
+import org.onosproject.incubator.net.tunnel.Tunnel.State;
+import org.onosproject.incubator.net.tunnel.Tunnel.Type;
+import org.onosproject.incubator.net.tunnel.TunnelAdminService;
+import org.onosproject.incubator.net.tunnel.TunnelDescription;
+import org.onosproject.incubator.net.tunnel.TunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.TunnelEvent;
+import org.onosproject.incubator.net.tunnel.TunnelId;
+import org.onosproject.incubator.net.tunnel.TunnelListener;
+import org.onosproject.incubator.net.tunnel.TunnelName;
+import org.onosproject.incubator.net.tunnel.TunnelProvider;
+import org.onosproject.incubator.net.tunnel.TunnelProviderRegistry;
+import org.onosproject.incubator.net.tunnel.TunnelProviderService;
+import org.onosproject.incubator.net.tunnel.TunnelService;
+import org.onosproject.incubator.net.tunnel.TunnelStore;
+import org.onosproject.incubator.net.tunnel.TunnelStoreDelegate;
+import org.onosproject.incubator.net.tunnel.TunnelSubscription;
+import org.onosproject.net.Annotations;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.ElementId;
+import org.onosproject.net.Path;
+import org.onosproject.net.provider.AbstractListenerProviderRegistry;
+import org.onosproject.net.provider.AbstractProviderService;
+import org.onosproject.net.provider.ProviderId;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Deactivate;
+import org.osgi.service.component.annotations.Reference;
+import org.osgi.service.component.annotations.ReferenceCardinality;
+import org.slf4j.Logger;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Set;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+import static org.slf4j.LoggerFactory.getLogger;
+
+/**
+ * Provides implementation of the tunnel NB/SB APIs.
+ */
+@Component(immediate = true, service = {TunnelService.class, TunnelAdminService.class, TunnelProviderRegistry.class})
+public class TunnelManager
+ extends AbstractListenerProviderRegistry<TunnelEvent, TunnelListener,
+ TunnelProvider, TunnelProviderService>
+ implements TunnelService, TunnelAdminService, TunnelProviderRegistry {
+
+ private static final String TUNNNEL_ID_NULL = "Tunnel ID cannot be null";
+ private static final String TUNNNEL_NULL = "Tunnel cannot be null";
+
+ private final Logger log = getLogger(getClass());
+
+ private final TunnelStoreDelegate delegate = new InternalStoreDelegate();
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY)
+ protected TunnelStore store;
+
+
+ @Activate
+ public void activate() {
+ store.setDelegate(delegate);
+ eventDispatcher.addSink(TunnelEvent.class, listenerRegistry);
+ log.info("Started");
+ }
+
+ @Deactivate
+ public void deactivate() {
+ store.unsetDelegate(delegate);
+ eventDispatcher.removeSink(TunnelEvent.class);
+ log.info("Stopped");
+ }
+
+ @Override
+ public void removeTunnel(TunnelId tunnelId) {
+ checkNotNull(tunnelId, TUNNNEL_ID_NULL);
+ Tunnel tunnel = store.queryTunnel(tunnelId);
+ if (tunnel != null) {
+ store.deleteTunnel(tunnelId);
+ if (tunnel.providerId() != null) {
+ TunnelProvider provider = getProvider(tunnel.providerId());
+ if (provider != null) {
+ provider.releaseTunnel(tunnel);
+ }
+ } else {
+ Set<ProviderId> ids = getProviders();
+ for (ProviderId providerId : ids) {
+ TunnelProvider provider = getProvider(providerId);
+ provider.releaseTunnel(tunnel);
+ }
+ }
+ }
+ }
+
+ @Override
+ public void updateTunnel(Tunnel tunnel, Path path) {
+ store.createOrUpdateTunnel(tunnel);
+ if (tunnel.providerId() != null) {
+ TunnelProvider provider = getProvider(tunnel.providerId());
+ if (provider != null) {
+ provider.updateTunnel(tunnel, path);
+ }
+ } else {
+ Set<ProviderId> ids = getProviders();
+ for (ProviderId providerId : ids) {
+ TunnelProvider provider = getProvider(providerId);
+ provider.updateTunnel(tunnel, path);
+ }
+ }
+ }
+
+ @Override
+ public void updateTunnelState(Tunnel tunnel, State state) {
+ Tunnel storedTunnel = store.queryTunnel(tunnel.tunnelId());
+ store.createOrUpdateTunnel(storedTunnel, state);
+ }
+
+ @Override
+ public void removeTunnels(TunnelEndPoint src, TunnelEndPoint dst,
+ ProviderId producerName) {
+ Collection<Tunnel> setTunnels = store.queryTunnel(src, dst);
+ if (!setTunnels.isEmpty()) {
+ store.deleteTunnel(src, dst, producerName);
+ for (Tunnel tunnel : setTunnels) {
+ if (producerName != null
+ && !tunnel.providerId().equals(producerName)) {
+ continue;
+ }
+ if (tunnel.providerId() != null) {
+ TunnelProvider provider = getProvider(tunnel.providerId());
+ if (provider != null) {
+ provider.releaseTunnel(tunnel);
+ }
+ } else {
+ Set<ProviderId> ids = getProviders();
+ for (ProviderId providerId : ids) {
+ TunnelProvider provider = getProvider(providerId);
+ provider.releaseTunnel(tunnel);
+ }
+ }
+ }
+ }
+ }
+
+ @Override
+ public void removeTunnels(TunnelEndPoint src, TunnelEndPoint dst, Type type,
+ ProviderId producerName) {
+ Collection<Tunnel> setTunnels = store.queryTunnel(src, dst);
+ if (!setTunnels.isEmpty()) {
+ store.deleteTunnel(src, dst, type, producerName);
+ for (Tunnel tunnel : setTunnels) {
+ if (producerName != null
+ && !tunnel.providerId().equals(producerName)
+ || !type.equals(tunnel.type())) {
+ continue;
+ }
+ if (tunnel.providerId() != null) {
+ TunnelProvider provider = getProvider(tunnel.providerId());
+ if (provider != null) {
+ provider.releaseTunnel(tunnel);
+ }
+ } else {
+ Set<ProviderId> ids = getProviders();
+ for (ProviderId providerId : ids) {
+ TunnelProvider provider = getProvider(providerId);
+ provider.releaseTunnel(tunnel);
+ }
+ }
+ }
+ }
+ }
+
+ @Override
+ public Tunnel borrowTunnel(ApplicationId consumerId, TunnelId tunnelId,
+ Annotations... annotations) {
+ return store.borrowTunnel(consumerId, tunnelId, annotations);
+ }
+
+ @Override
+ public Collection<Tunnel> borrowTunnel(ApplicationId consumerId,
+ TunnelName tunnelName,
+ Annotations... annotations) {
+ return store.borrowTunnel(consumerId, tunnelName, annotations);
+ }
+
+ @Override
+ public Collection<Tunnel> borrowTunnel(ApplicationId consumerId,
+ TunnelEndPoint src, TunnelEndPoint dst,
+ Annotations... annotations) {
+ Collection<Tunnel> tunnels = store.borrowTunnel(consumerId, src,
+ dst, annotations);
+ if (tunnels == null || tunnels.isEmpty()) {
+ Tunnel tunnel = new DefaultTunnel(null, src, dst, null, null, null,
+ null, null, annotations);
+ Set<ProviderId> ids = getProviders();
+ for (ProviderId providerId : ids) {
+ TunnelProvider provider = getProvider(providerId);
+ provider.setupTunnel(tunnel, null);
+ }
+ }
+ return tunnels;
+ }
+
+ @Override
+ public Collection<Tunnel> borrowTunnel(ApplicationId consumerId,
+ TunnelEndPoint src, TunnelEndPoint dst,
+ Type type, Annotations... annotations) {
+ Collection<Tunnel> tunnels = store.borrowTunnel(consumerId, src,
+ dst, type,
+ annotations);
+ if (tunnels == null || tunnels.isEmpty()) {
+ Tunnel tunnel = new DefaultTunnel(null, src, dst, type, null, null,
+ null, null, annotations);
+ Set<ProviderId> ids = getProviders();
+ for (ProviderId providerId : ids) {
+ TunnelProvider provider = getProvider(providerId);
+ provider.setupTunnel(tunnel, null);
+ }
+ }
+ return tunnels;
+ }
+
+ @Override
+ public TunnelId setupTunnel(ApplicationId producerId, ElementId srcElementId, Tunnel tunnel, Path path) {
+ // TODO: producerId to check if really required to consider while setup the tunnel.
+ checkNotNull(tunnel, TUNNNEL_NULL);
+ TunnelId tunnelId = store.createOrUpdateTunnel(tunnel, State.INIT);
+ if (tunnelId != null) {
+ Set<ProviderId> ids = getProviders();
+ Tunnel newT = queryTunnel(tunnelId);
+ for (ProviderId providerId : ids) {
+ TunnelProvider provider = getProvider(providerId);
+ provider.setupTunnel(srcElementId, newT, path);
+ }
+ }
+ return tunnelId;
+ }
+
+ @Override
+ public boolean downTunnel(ApplicationId producerId, TunnelId tunnelId) {
+ // TODO: producerId to check if really required to consider while deleting the tunnel.
+ checkNotNull(tunnelId, TUNNNEL_ID_NULL);
+ Tunnel tunnel = store.queryTunnel(tunnelId);
+ if (tunnel != null) {
+ TunnelId updtTunnelId = store.createOrUpdateTunnel(tunnel, State.INACTIVE);
+ if (updtTunnelId != null) {
+ Set<ProviderId> ids = getProviders();
+ for (ProviderId providerId : ids) {
+ TunnelProvider provider = getProvider(providerId);
+ provider.releaseTunnel(tunnel);
+ }
+ }
+ return true;
+ }
+ return false;
+ }
+
+ @Override
+ public boolean returnTunnel(ApplicationId consumerId,
+ TunnelId tunnelId, Annotations... annotations) {
+ return store.returnTunnel(consumerId, tunnelId, annotations);
+ }
+
+ @Override
+ public boolean returnTunnel(ApplicationId consumerId,
+ TunnelName tunnelName,
+ Annotations... annotations) {
+ return store.returnTunnel(consumerId, tunnelName, annotations);
+ }
+
+ @Override
+ public boolean returnTunnel(ApplicationId consumerId, TunnelEndPoint src,
+ TunnelEndPoint dst, Type type,
+ Annotations... annotations) {
+ return store.returnTunnel(consumerId, src, dst, type, annotations);
+ }
+
+ @Override
+ public boolean returnTunnel(ApplicationId consumerId, TunnelEndPoint src,
+ TunnelEndPoint dst, Annotations... annotations) {
+ return store.returnTunnel(consumerId, src, dst, annotations);
+ }
+
+ @Override
+ public Tunnel queryTunnel(TunnelId tunnelId) {
+ return store.queryTunnel(tunnelId);
+ }
+
+ @Override
+ public Collection<TunnelSubscription> queryTunnelSubscription(ApplicationId consumerId) {
+ return store.queryTunnelSubscription(consumerId);
+ }
+
+ @Override
+ public Collection<Tunnel> queryTunnel(Type type) {
+ return store.queryTunnel(type);
+ }
+
+ @Override
+ public Collection<Tunnel> queryTunnel(TunnelEndPoint src, TunnelEndPoint dst) {
+ return store.queryTunnel(src, dst);
+ }
+
+
+ @Override
+ public Collection<Tunnel> queryAllTunnels() {
+ return store.queryAllTunnels();
+ }
+
+ @Override
+ public int tunnelCount() {
+ return store.tunnelCount();
+ }
+
+ @Override
+ protected TunnelProviderService createProviderService(TunnelProvider provider) {
+ return new InternalTunnelProviderService(provider);
+ }
+
+ private class InternalTunnelProviderService
+ extends AbstractProviderService<TunnelProvider>
+ implements TunnelProviderService {
+ protected InternalTunnelProviderService(TunnelProvider provider) {
+ super(provider);
+ }
+
+
+ @Override
+ public TunnelId tunnelAdded(TunnelDescription tunnel) {
+ Tunnel storedTunnel = new DefaultTunnel(provider().id(),
+ tunnel.src(), tunnel.dst(),
+ tunnel.type(),
+ tunnel.groupId(),
+ tunnel.id(),
+ tunnel.tunnelName(),
+ tunnel.path(),
+ tunnel.resource(),
+ tunnel.annotations());
+ return store.createOrUpdateTunnel(storedTunnel);
+ }
+
+ @Override
+ public TunnelId tunnelAdded(TunnelDescription tunnel, State state) {
+ Tunnel storedTunnel = new DefaultTunnel(provider().id(),
+ tunnel.src(), tunnel.dst(),
+ tunnel.type(),
+ state,
+ tunnel.groupId(),
+ tunnel.id(),
+ tunnel.tunnelName(),
+ tunnel.path(),
+ tunnel.resource(),
+ tunnel.annotations());
+ return store.createOrUpdateTunnel(storedTunnel);
+ }
+
+ @Override
+ public void tunnelUpdated(TunnelDescription tunnel) {
+ Tunnel storedTunnel = new DefaultTunnel(provider().id(),
+ tunnel.src(), tunnel.dst(),
+ tunnel.type(),
+ tunnel.groupId(),
+ tunnel.id(),
+ tunnel.tunnelName(),
+ tunnel.path(),
+ tunnel.resource(),
+ tunnel.annotations());
+ store.createOrUpdateTunnel(storedTunnel);
+ }
+
+ @Override
+ public void tunnelUpdated(TunnelDescription tunnel, State state) {
+ Tunnel storedTunnel = new DefaultTunnel(provider().id(),
+ tunnel.src(), tunnel.dst(),
+ tunnel.type(),
+ state,
+ tunnel.groupId(),
+ tunnel.id(),
+ tunnel.tunnelName(),
+ tunnel.path(),
+ tunnel.resource(),
+ tunnel.annotations());
+ store.createOrUpdateTunnel(storedTunnel, state);
+ }
+
+ @Override
+ public void tunnelRemoved(TunnelDescription tunnel) {
+ if (tunnel.id() != null) {
+ store.deleteTunnel(tunnel.id());
+ return;
+ }
+ if (tunnel.src() != null && tunnel.dst() != null
+ && tunnel.type() != null) {
+ store.deleteTunnel(tunnel.src(), tunnel.dst(), tunnel.type(),
+ provider().id());
+ return;
+ }
+ if (tunnel.src() != null && tunnel.dst() != null
+ && tunnel.type() == null) {
+ store.deleteTunnel(tunnel.src(), tunnel.dst(), provider().id());
+ return;
+ }
+ }
+
+
+ @Override
+ public Tunnel tunnelQueryById(TunnelId tunnelId) {
+ return store.queryTunnel(tunnelId);
+ }
+
+
+ }
+
+ private class InternalStoreDelegate implements TunnelStoreDelegate {
+ @Override
+ public void notify(TunnelEvent event) {
+ if (event != null) {
+ post(event);
+ }
+ }
+ }
+
+ @Override
+ public Iterable<Tunnel> getTunnels(DeviceId deviceId) {
+ return Collections.emptyList();
+ }
+
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/impl/package-info.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/impl/package-info.java
new file mode 100644
index 0000000..5926b0a
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/impl/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.
+ */
+
+/**
+ * Core subsystem for tracking global inventory of tunnels.
+ */
+package org.onosproject.incubator.net.tunnel.impl;
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/store/impl/DistributedTunnelStore.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/store/impl/DistributedTunnelStore.java
new file mode 100644
index 0000000..3bf5e35
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/store/impl/DistributedTunnelStore.java
@@ -0,0 +1,583 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel.store.impl;
+
+import com.google.common.base.MoreObjects;
+import com.google.common.collect.ImmutableSet;
+import com.google.common.collect.Maps;
+import org.onlab.util.KryoNamespace;
+import org.onosproject.cluster.ClusterService;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.core.CoreService;
+import org.onosproject.core.IdGenerator;
+import org.onosproject.incubator.net.tunnel.DefaultTunnel;
+import org.onosproject.incubator.net.tunnel.Tunnel;
+import org.onosproject.incubator.net.tunnel.Tunnel.State;
+import org.onosproject.incubator.net.tunnel.Tunnel.Type;
+import org.onosproject.incubator.net.tunnel.TunnelEndPoint;
+import org.onosproject.incubator.net.tunnel.TunnelEvent;
+import org.onosproject.incubator.net.tunnel.TunnelId;
+import org.onosproject.incubator.net.tunnel.TunnelName;
+import org.onosproject.incubator.net.tunnel.TunnelStore;
+import org.onosproject.incubator.net.tunnel.TunnelStoreDelegate;
+import org.onosproject.incubator.net.tunnel.TunnelSubscription;
+import org.onosproject.net.Annotations;
+import org.onosproject.net.DefaultAnnotations;
+import org.onosproject.net.SparseAnnotations;
+import org.onosproject.net.provider.ProviderId;
+import org.onosproject.store.AbstractStore;
+import org.onosproject.store.cluster.messaging.ClusterCommunicationService;
+import org.onosproject.store.serializers.KryoNamespaces;
+import org.onosproject.store.service.EventuallyConsistentMap;
+import org.onosproject.store.service.EventuallyConsistentMapEvent;
+import org.onosproject.store.service.EventuallyConsistentMapListener;
+import org.onosproject.store.service.MultiValuedTimestamp;
+import org.onosproject.store.service.StorageService;
+import org.onosproject.store.service.WallClockTimestamp;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Deactivate;
+import org.osgi.service.component.annotations.Reference;
+import org.osgi.service.component.annotations.ReferenceCardinality;
+import org.slf4j.Logger;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.Set;
+
+import static org.onosproject.store.service.EventuallyConsistentMapEvent.Type.PUT;
+import static org.onosproject.store.service.EventuallyConsistentMapEvent.Type.REMOVE;
+import static org.slf4j.LoggerFactory.getLogger;
+
+/**
+ * Manages inventory of tunnel in distributed data store that uses optimistic
+ * replication and gossip based techniques.
+ */
+@Component(immediate = true, service = TunnelStore.class)
+public class DistributedTunnelStore
+ extends AbstractStore<TunnelEvent, TunnelStoreDelegate>
+ implements TunnelStore {
+
+ private final Logger log = getLogger(getClass());
+
+ /**
+ * The topic used for obtaining globally unique ids.
+ */
+ private String tunnelOpTopic = "tunnel-ops-ids";
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY)
+ protected ClusterCommunicationService clusterCommunicator;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY)
+ protected ClusterService clusterService;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY)
+ protected CoreService coreService;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY)
+ protected StorageService storageService;
+
+ // tunnel identity as map key in the store.
+ private EventuallyConsistentMap<TunnelId, Tunnel> tunnelIdAsKeyStore;
+ // maintains records that app subscribes tunnel.
+ private EventuallyConsistentMap<ApplicationId, Set<TunnelSubscription>> orderRelationship;
+
+ // tunnel name as map key.
+ private final Map<TunnelName, Set<TunnelId>> tunnelNameAsKeyMap = Maps.newConcurrentMap();
+ // maintains all the tunnels between source and destination.
+ private final Map<TunnelKey, Set<TunnelId>> srcAndDstKeyMap = Maps.newConcurrentMap();
+ // maintains all the tunnels by tunnel type.
+ private final Map<Tunnel.Type, Set<TunnelId>> typeKeyMap = Maps.newConcurrentMap();
+
+ private IdGenerator idGenerator;
+
+ private EventuallyConsistentMapListener<TunnelId, Tunnel> tunnelUpdateListener =
+ new InternalTunnelChangeEventListener();
+
+ @Activate
+ public void activate() {
+ KryoNamespace.Builder serializer = KryoNamespace.newBuilder()
+ .register(KryoNamespaces.API)
+ .register(MultiValuedTimestamp.class);
+ tunnelIdAsKeyStore = storageService
+ .<TunnelId, Tunnel>eventuallyConsistentMapBuilder()
+ .withName("all_tunnel").withSerializer(serializer)
+ .withTimestampProvider((k, v) -> new WallClockTimestamp()).build();
+ orderRelationship = storageService
+ .<ApplicationId, Set<TunnelSubscription>>eventuallyConsistentMapBuilder()
+ .withName("type_tunnel").withSerializer(serializer)
+ .withTimestampProvider((k, v) -> new WallClockTimestamp()).build();
+ idGenerator = coreService.getIdGenerator(tunnelOpTopic);
+ tunnelIdAsKeyStore.addListener(tunnelUpdateListener);
+ log.info("Started");
+ }
+
+ @Deactivate
+ public void deactivate() {
+ tunnelIdAsKeyStore.removeListener(tunnelUpdateListener);
+ orderRelationship.destroy();
+ tunnelIdAsKeyStore.destroy();
+ srcAndDstKeyMap.clear();
+ typeKeyMap.clear();
+ tunnelNameAsKeyMap.clear();
+ log.info("Stopped");
+ }
+
+ @Override
+ public TunnelId createOrUpdateTunnel(Tunnel tunnel) {
+ return handleCreateOrUpdateTunnel(tunnel, null);
+ }
+
+ @Override
+ public TunnelId createOrUpdateTunnel(Tunnel tunnel, State state) {
+ return handleCreateOrUpdateTunnel(tunnel, state);
+ }
+
+ private TunnelId handleCreateOrUpdateTunnel(Tunnel tunnel, State state) {
+ // tunnelIdAsKeyStore.
+ if (tunnel.tunnelId() != null && !"".equals(tunnel.tunnelId().toString())) {
+ Tunnel old = tunnelIdAsKeyStore.get(tunnel.tunnelId());
+ if (old == null) {
+ log.info("This tunnel[" + tunnel.tunnelId() + "] is not available.");
+ return tunnel.tunnelId();
+ }
+ DefaultAnnotations oldAnno = (DefaultAnnotations) old.annotations();
+ SparseAnnotations newAnno = (SparseAnnotations) tunnel.annotations();
+ State newTunnelState = (state != null) ? state : old.state();
+ Tunnel newT = new DefaultTunnel(old.providerId(), old.src(),
+ old.dst(), old.type(),
+ newTunnelState, old.groupId(),
+ old.tunnelId(),
+ old.tunnelName(),
+ old.path(),
+ old.resource(),
+ DefaultAnnotations.merge(oldAnno, newAnno));
+ tunnelIdAsKeyStore.put(tunnel.tunnelId(), newT);
+ TunnelEvent event = new TunnelEvent(TunnelEvent.Type.TUNNEL_UPDATED,
+ tunnel);
+ notifyDelegate(event);
+ return tunnel.tunnelId();
+ } else {
+ TunnelId tunnelId = TunnelId.valueOf(String.valueOf(idGenerator.getNewId()));
+ State tunnelState = (state != null) ? state : tunnel.state();
+ Tunnel newT = new DefaultTunnel(tunnel.providerId(), tunnel.src(),
+ tunnel.dst(), tunnel.type(),
+ tunnelState, tunnel.groupId(),
+ tunnelId,
+ tunnel.tunnelName(),
+ tunnel.path(),
+ tunnel.resource(),
+ tunnel.annotations());
+ tunnelIdAsKeyStore.put(tunnelId, newT);
+
+ TunnelEvent event = new TunnelEvent(TunnelEvent.Type.TUNNEL_ADDED,
+ tunnel);
+ notifyDelegate(event);
+ return tunnelId;
+ }
+ }
+
+ @Override
+ public void deleteTunnel(TunnelId tunnelId) {
+ Tunnel deletedTunnel = tunnelIdAsKeyStore.get(tunnelId);
+ if (deletedTunnel == null) {
+ return;
+ }
+
+ tunnelIdAsKeyStore.remove(tunnelId);
+
+ TunnelEvent event = new TunnelEvent(TunnelEvent.Type.TUNNEL_REMOVED,
+ deletedTunnel);
+ notifyDelegate(event);
+ }
+
+ @Override
+ public void deleteTunnel(TunnelEndPoint src, TunnelEndPoint dst,
+ ProviderId producerName) {
+ TunnelKey key = TunnelKey.tunnelKey(src, dst);
+ Set<TunnelId> idSet = srcAndDstKeyMap.get(key);
+ if (idSet == null) {
+ return;
+ }
+ Tunnel deletedTunnel = null;
+ TunnelEvent event = null;
+ List<TunnelEvent> ls = new ArrayList<TunnelEvent>();
+ for (TunnelId id : idSet) {
+ deletedTunnel = tunnelIdAsKeyStore.get(id);
+
+ if (producerName == null || producerName.equals(deletedTunnel.providerId())) {
+ tunnelIdAsKeyStore.remove(deletedTunnel.tunnelId());
+
+ event = new TunnelEvent(TunnelEvent.Type.TUNNEL_REMOVED,
+ deletedTunnel);
+ ls.add(event);
+ }
+ }
+
+ if (!ls.isEmpty()) {
+ notifyDelegate(ls);
+ }
+ }
+
+ @Override
+ public void deleteTunnel(TunnelEndPoint src, TunnelEndPoint dst, Type type,
+ ProviderId producerName) {
+ TunnelKey key = TunnelKey.tunnelKey(src, dst);
+ Set<TunnelId> idSet = srcAndDstKeyMap.get(key);
+ if (idSet == null) {
+ return;
+ }
+ Tunnel deletedTunnel = null;
+ TunnelEvent event = null;
+ List<TunnelEvent> ls = new ArrayList<TunnelEvent>();
+ for (TunnelId id : idSet) {
+ deletedTunnel = tunnelIdAsKeyStore.get(id);
+
+ if (type.equals(deletedTunnel.type()) && (producerName == null ||
+ producerName.equals(deletedTunnel.providerId()))) {
+ tunnelIdAsKeyStore.remove(deletedTunnel.tunnelId());
+
+ event = new TunnelEvent(TunnelEvent.Type.TUNNEL_REMOVED,
+ deletedTunnel);
+ ls.add(event);
+ }
+ }
+
+ if (!ls.isEmpty()) {
+ notifyDelegate(ls);
+ }
+ }
+
+ @Override
+ public Tunnel borrowTunnel(ApplicationId appId, TunnelId tunnelId,
+ Annotations... annotations) {
+ Set<TunnelSubscription> orderSet = orderRelationship.get(appId);
+ if (orderSet == null) {
+ orderSet = new HashSet<TunnelSubscription>();
+ }
+ TunnelSubscription order = new TunnelSubscription(appId, null, null, tunnelId, null, null,
+ annotations);
+ Tunnel result = tunnelIdAsKeyStore.get(tunnelId);
+ if (result == null || Tunnel.State.INACTIVE.equals(result.state())) {
+ return null;
+ }
+
+ orderSet.add(order);
+ orderRelationship.put(appId, orderSet);
+ return result;
+ }
+
+ @Override
+ public Collection<Tunnel> borrowTunnel(ApplicationId appId,
+ TunnelEndPoint src,
+ TunnelEndPoint dst,
+ Annotations... annotations) {
+ Set<TunnelSubscription> orderSet = orderRelationship.get(appId);
+ if (orderSet == null) {
+ orderSet = new HashSet<TunnelSubscription>();
+ }
+ TunnelSubscription order = new TunnelSubscription(appId, src, dst, null, null, null, annotations);
+ boolean isExist = orderSet.contains(order);
+ if (!isExist) {
+ orderSet.add(order);
+ }
+ orderRelationship.put(appId, orderSet);
+ TunnelKey key = TunnelKey.tunnelKey(src, dst);
+ Set<TunnelId> idSet = srcAndDstKeyMap.get(key);
+ if (idSet == null || idSet.isEmpty()) {
+ return Collections.emptySet();
+ }
+ Collection<Tunnel> tunnelSet = new HashSet<Tunnel>();
+ for (TunnelId tunnelId : idSet) {
+ Tunnel result = tunnelIdAsKeyStore.get(tunnelId);
+ if (Tunnel.State.ACTIVE.equals(result.state())) {
+ tunnelSet.add(result);
+ }
+ }
+ return tunnelSet;
+ }
+
+ @Override
+ public Collection<Tunnel> borrowTunnel(ApplicationId appId,
+ TunnelEndPoint src,
+ TunnelEndPoint dst, Type type,
+ Annotations... annotations) {
+ Set<TunnelSubscription> orderSet = orderRelationship.get(appId);
+ if (orderSet == null) {
+ orderSet = new HashSet<TunnelSubscription>();
+ }
+ TunnelSubscription order = new TunnelSubscription(appId, src, dst, null, type, null, annotations);
+ boolean isExist = orderSet.contains(order);
+ if (!isExist) {
+ orderSet.add(order);
+ }
+ orderRelationship.put(appId, orderSet);
+ TunnelKey key = TunnelKey.tunnelKey(src, dst);
+ Set<TunnelId> idSet = srcAndDstKeyMap.get(key);
+ if (idSet == null || idSet.isEmpty()) {
+ return Collections.emptySet();
+ }
+ Collection<Tunnel> tunnelSet = new HashSet<Tunnel>();
+ for (TunnelId tunnelId : idSet) {
+ Tunnel result = tunnelIdAsKeyStore.get(tunnelId);
+ if (type.equals(result.type())
+ && Tunnel.State.ACTIVE.equals(result.state())) {
+ tunnelSet.add(result);
+ }
+ }
+ return tunnelSet;
+ }
+
+ @Override
+ public Collection<Tunnel> borrowTunnel(ApplicationId appId,
+ TunnelName tunnelName,
+ Annotations... annotations) {
+ Set<TunnelSubscription> orderSet = orderRelationship.get(appId);
+ if (orderSet == null) {
+ orderSet = new HashSet<TunnelSubscription>();
+ }
+ TunnelSubscription order = new TunnelSubscription(appId, null, null, null, null, tunnelName,
+ annotations);
+ boolean isExist = orderSet.contains(order);
+
+ Set<TunnelId> idSet = tunnelNameAsKeyMap.get(tunnelName);
+ if (idSet == null || idSet.isEmpty()) {
+ return Collections.emptySet();
+ }
+ Collection<Tunnel> tunnelSet = new HashSet<Tunnel>();
+ for (TunnelId tunnelId : idSet) {
+ Tunnel result = tunnelIdAsKeyStore.get(tunnelId);
+ if (Tunnel.State.ACTIVE.equals(result.state())) {
+ tunnelSet.add(result);
+ }
+ }
+
+ if (!tunnelSet.isEmpty() && !isExist) {
+ orderSet.add(order);
+ orderRelationship.put(appId, orderSet);
+ }
+
+ return tunnelSet;
+ }
+
+ @Override
+ public boolean returnTunnel(ApplicationId appId, TunnelName tunnelName,
+ Annotations... annotations) {
+ TunnelSubscription order = new TunnelSubscription(appId, null, null, null, null, tunnelName,
+ annotations);
+ return deleteOrder(order);
+ }
+
+ @Override
+ public boolean returnTunnel(ApplicationId appId, TunnelId tunnelId,
+ Annotations... annotations) {
+ TunnelSubscription order = new TunnelSubscription(appId, null, null, tunnelId, null, null,
+ annotations);
+ return deleteOrder(order);
+ }
+
+ @Override
+ public boolean returnTunnel(ApplicationId appId, TunnelEndPoint src,
+ TunnelEndPoint dst, Type type,
+ Annotations... annotations) {
+ TunnelSubscription order = new TunnelSubscription(appId, src, dst, null, type, null, annotations);
+ return deleteOrder(order);
+ }
+
+ @Override
+ public boolean returnTunnel(ApplicationId appId, TunnelEndPoint src,
+ TunnelEndPoint dst, Annotations... annotations) {
+ TunnelSubscription order = new TunnelSubscription(appId, src, dst, null, null, null, annotations);
+ return deleteOrder(order);
+ }
+
+ private boolean deleteOrder(TunnelSubscription order) {
+ Set<TunnelSubscription> orderSet = orderRelationship.get(order.consumerId());
+ if (orderSet == null) {
+ return true;
+ }
+ if (orderSet.contains(order)) {
+ orderSet.remove(order);
+ return true;
+ }
+ return false;
+ }
+
+ @Override
+ public Tunnel queryTunnel(TunnelId tunnelId) {
+ return tunnelIdAsKeyStore.get(tunnelId);
+ }
+
+ @Override
+ public Collection<TunnelSubscription> queryTunnelSubscription(ApplicationId appId) {
+ return orderRelationship.get(appId) != null ? ImmutableSet.copyOf(orderRelationship
+ .get(appId)) : Collections.emptySet();
+ }
+
+ @Override
+ public Collection<Tunnel> queryTunnel(Type type) {
+ Collection<Tunnel> result = new HashSet<Tunnel>();
+ Set<TunnelId> tunnelIds = typeKeyMap.get(type);
+ if (tunnelIds == null) {
+ return Collections.emptySet();
+ }
+ for (TunnelId id : tunnelIds) {
+ result.add(tunnelIdAsKeyStore.get(id));
+ }
+ return result.isEmpty() ? Collections.emptySet() : ImmutableSet
+ .copyOf(result);
+ }
+
+ @Override
+ public Collection<Tunnel> queryTunnel(TunnelEndPoint src, TunnelEndPoint dst) {
+ Collection<Tunnel> result = new HashSet<Tunnel>();
+ TunnelKey key = TunnelKey.tunnelKey(src, dst);
+ Set<TunnelId> tunnelIds = srcAndDstKeyMap.get(key);
+ if (tunnelIds == null) {
+ return Collections.emptySet();
+ }
+ for (TunnelId id : tunnelIds) {
+ result.add(tunnelIdAsKeyStore.get(id));
+ }
+ return result.isEmpty() ? Collections.emptySet() : ImmutableSet
+ .copyOf(result);
+ }
+
+ @Override
+ public Collection<Tunnel> queryAllTunnels() {
+ return tunnelIdAsKeyStore.values();
+ }
+
+ @Override
+ public int tunnelCount() {
+ return tunnelIdAsKeyStore.size();
+ }
+
+ /**
+ * Uses source TunnelPoint and destination TunnelPoint as map key.
+ */
+ private static final class TunnelKey {
+ private final TunnelEndPoint src;
+ private final TunnelEndPoint dst;
+
+ private TunnelKey(TunnelEndPoint src, TunnelEndPoint dst) {
+ this.src = src;
+ this.dst = dst;
+
+ }
+
+ /**
+ * create a map key.
+ *
+ * @param src
+ * @param dst
+ * @return a key using source ip and destination ip
+ */
+ static TunnelKey tunnelKey(TunnelEndPoint src, TunnelEndPoint dst) {
+ return new TunnelKey(src, dst);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(src, dst);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (obj instanceof TunnelKey) {
+ final TunnelKey other = (TunnelKey) obj;
+ return Objects.equals(this.src, other.src)
+ && Objects.equals(this.dst, other.dst);
+ }
+ return false;
+ }
+
+ @Override
+ public String toString() {
+ return MoreObjects.toStringHelper(getClass()).add("src", src)
+ .add("dst", dst).toString();
+ }
+ }
+
+ /**
+ * Eventually consistent map listener for tunnel change event which updated the local map based on event.
+ */
+ private class InternalTunnelChangeEventListener
+ implements EventuallyConsistentMapListener<TunnelId, Tunnel> {
+ @Override
+ public void event(EventuallyConsistentMapEvent<TunnelId, Tunnel> event) {
+ TunnelId tunnelId = event.key();
+ Tunnel tunnel = event.value();
+
+ if (event.type() == PUT) {
+
+ // Update tunnel name map
+ Set<TunnelId> tunnelNameSet = tunnelNameAsKeyMap.get(tunnel
+ .tunnelName());
+ if (tunnelNameSet == null) {
+ tunnelNameSet = new HashSet<TunnelId>();
+ }
+ tunnelNameSet.add(tunnelId);
+ tunnelNameAsKeyMap.put(tunnel.tunnelName(), tunnelNameSet);
+
+ // Update tunnel source and destination map
+ TunnelKey key = TunnelKey.tunnelKey(tunnel.src(), tunnel.dst());
+ Set<TunnelId> srcAndDstKeySet = srcAndDstKeyMap.get(key);
+ if (srcAndDstKeySet == null) {
+ srcAndDstKeySet = new HashSet<TunnelId>();
+ }
+ srcAndDstKeySet.add(tunnelId);
+ srcAndDstKeyMap.put(key, srcAndDstKeySet);
+
+ // Update tunnel type map
+ Set<TunnelId> typeKeySet = typeKeyMap.get(tunnel.type());
+ if (typeKeySet == null) {
+ typeKeySet = new HashSet<TunnelId>();
+ }
+ typeKeySet.add(tunnelId);
+ typeKeyMap.put(tunnel.type(), typeKeySet);
+ } else if (event.type() == REMOVE) {
+
+ // Update tunnel name map
+ tunnelNameAsKeyMap.get(tunnel.tunnelName()).remove(tunnelId);
+ if (tunnelNameAsKeyMap.get(tunnel.tunnelName()).isEmpty()) {
+ tunnelNameAsKeyMap.remove(tunnel.tunnelName());
+ }
+
+ // Update tunnel source and destination map
+ TunnelKey key = TunnelKey.tunnelKey(tunnel.src(), tunnel.dst());
+ srcAndDstKeyMap.get(key).remove(tunnelId);
+ if (srcAndDstKeyMap.get(key).isEmpty()) {
+ srcAndDstKeyMap.remove(key);
+ }
+
+ // Update tunnel type map
+ typeKeyMap.get(tunnel.type()).remove(tunnelId);
+ if (typeKeyMap.get(tunnel.type()).isEmpty()) {
+ typeKeyMap.remove(tunnel.type());
+ }
+ }
+ }
+ }
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/store/impl/package-info.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/store/impl/package-info.java
new file mode 100644
index 0000000..09d5277
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/store/impl/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.
+ */
+
+/**
+ * Implementation of distributed tunnel store using p2p synchronization protocol.
+ */
+package org.onosproject.incubator.net.tunnel.store.impl;
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/ui/TunnelViewMessageHandler.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/ui/TunnelViewMessageHandler.java
new file mode 100644
index 0000000..7ffd50d
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/ui/TunnelViewMessageHandler.java
@@ -0,0 +1,102 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.incubator.net.tunnel.ui;
+
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.google.common.collect.ImmutableSet;
+import org.onosproject.incubator.net.tunnel.Tunnel;
+import org.onosproject.incubator.net.tunnel.TunnelEndPointFormatter;
+import org.onosproject.incubator.net.tunnel.TunnelService;
+import org.onosproject.ui.RequestHandler;
+import org.onosproject.ui.UiMessageHandler;
+import org.onosproject.ui.table.TableModel;
+import org.onosproject.ui.table.TableRequestHandler;
+import org.onosproject.ui.table.cell.EnumFormatter;
+
+import java.util.Collection;
+
+public class TunnelViewMessageHandler extends UiMessageHandler {
+ private static final String TUNNEL_DATA_REQ = "tunnelDataRequest";
+ private static final String TUNNEL_DATA_RESP = "tunnelDataResponse";
+ private static final String TUNNELS = "tunnels";
+ private static final String ID = "id";
+ private static final String NAME = "name";
+ private static final String ONE = "one";
+ private static final String TWO = "two";
+ private static final String TYPE = "type";
+ private static final String GROUP_ID = "group_id";
+
+ private static final String BANDWIDTH = "bandwidth";
+ private static final String PATH = "path";
+
+
+ private static final String[] COL_IDS = {
+ ID, NAME, ONE, TWO, TYPE, GROUP_ID,
+ BANDWIDTH, PATH
+ };
+
+ @Override
+ protected Collection<RequestHandler> createRequestHandlers() {
+ return ImmutableSet.of(new TunnelDataRequestHandler());
+ }
+
+ private final class TunnelDataRequestHandler extends TableRequestHandler {
+
+ private static final String NO_ROWS_MESSAGE = "No tunnels found";
+
+ public TunnelDataRequestHandler() {
+ super(TUNNEL_DATA_REQ, TUNNEL_DATA_RESP, TUNNELS);
+ }
+
+ @Override
+ protected String[] getColumnIds() {
+ return COL_IDS;
+ }
+
+ @Override
+ protected String noRowsMessage(ObjectNode payload) {
+ return NO_ROWS_MESSAGE;
+ }
+
+ @Override
+ protected TableModel createTableModel() {
+ TableModel tm = super.createTableModel();
+ //TODO add more formater class so that we can get a more readable table
+ tm.setFormatter(ONE, TunnelEndPointFormatter.INSTANCE);
+ tm.setFormatter(TWO, TunnelEndPointFormatter.INSTANCE);
+ tm.setFormatter(TYPE, EnumFormatter.INSTANCE);
+ return tm;
+ }
+
+ @Override
+ protected void populateTable(TableModel tm, ObjectNode payload) {
+ TunnelService ts = get(TunnelService.class);
+ ts.queryAllTunnels().forEach(tunnel -> populateRow(tm.addRow(), tunnel));
+ }
+
+ }
+
+ private void populateRow(TableModel.Row row, Tunnel tunnel) {
+ row.cell(ID, tunnel.tunnelId().id())
+ .cell(NAME, tunnel.tunnelName().value())
+ .cell(ONE, tunnel.src())
+ .cell(TWO, tunnel.dst())
+ .cell(TYPE, tunnel.type())
+ .cell(GROUP_ID, tunnel.groupId().id())
+ .cell(BANDWIDTH, tunnel.annotations().value(BANDWIDTH))
+ .cell(PATH, tunnel.path());
+ }
+}
diff --git a/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/ui/package-info.java b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/ui/package-info.java
new file mode 100644
index 0000000..1b7baa0
--- /dev/null
+++ b/apps/tunnel/app/src/main/java/org/onosproject/incubator/net/tunnel/ui/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * 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.
+ */
+
+/**
+ * GUI for the tunnel subsystem.
+ */
+package org.onosproject.incubator.net.tunnel.ui;