org.onosproject.net.config.basics.BasicElementConfig Maven / Gradle / Ivy
/*
* 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.net.config.basics;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.google.common.collect.ImmutableSet;
import java.util.Objects;
import java.util.Set;
/**
* Basic configuration for network elements, e.g. devices, hosts. Such elements
* can have a friendly name, geo-coordinates (or grid-coordinates),
* logical rack coordinates and an owner entity.
*/
public abstract class BasicElementConfig extends AllowedEntityConfig {
/**
* Key for friendly name.
*/
public static final String NAME = "name";
/**
* Key for UI type (glyph identifier).
*/
public static final String UI_TYPE = "uiType";
/**
* Key for location type (geo or grid).
*/
public static final String LOC_TYPE = "locType";
/**
* Key for latitude.
*/
public static final String LATITUDE = "latitude";
/**
* Key for longitude.
*/
public static final String LONGITUDE = "longitude";
/**
* Key for grid Y coordinate.
*/
public static final String GRID_Y = "gridY";
/**
* Key for grid X coordinate.
*/
public static final String GRID_X = "gridX";
/**
* Key for rack address.
*/
protected static final String RACK_ADDRESS = "rackAddress";
/**
* Key for owner.
*/
protected static final String OWNER = "owner";
/**
* Key for roles.
*/
protected static final String ROLES = "roles";
/**
* Threshold for detecting double value is zero.
*/
protected static final double ZERO_THRESHOLD = Double.MIN_VALUE * 2.0;
private static final double DEFAULT_COORD = 0.0;
public static final String LOC_TYPE_GEO = "geo";
public static final String LOC_TYPE_GRID = "grid";
public static final String LOC_TYPE_NONE = "none";
private static final int NAME_MAX_LENGTH = 256;
private static final int UI_TYPE_MAX_LENGTH = 128;
private static final int LOC_TYPE_MAX_LENGTH = 32;
private static final int RACK_ADDRESS_MAX_LENGTH = 256;
private static final int OWNER_MAX_LENGTH = 128;
/**
* Returns friendly label for the element. If not set, returns the
* element identifier.
*
* @return friendly label or element identifier itself if not set
*/
public String name() {
return get(NAME, subject.toString());
}
/**
* Sets friendly label for the element.
*
* @param name new friendly label; null to clear
* @return self
*/
public BasicElementConfig name(String name) {
return (BasicElementConfig) setOrClear(NAME, name);
}
/**
* Returns the UI type (glyph image to be used) for the element in
* the Topology View. If not set, null is returned.
*
* @return the UI type
*/
public String uiType() {
return get(UI_TYPE, null);
}
/**
* Sets the UI type (glyph image to be used) for the element in
* the Topology View. Setting this to null will indicate that the
* default glyph image should be used for the element type.
*
* @param uiType the UI type; null for default
* @return self
*/
public BasicElementConfig uiType(String uiType) {
return (BasicElementConfig) setOrClear(UI_TYPE, uiType);
}
/**
* Returns the location type (geo or grid) for the element in
* the Topology View. If not set, the type will be determined implicitly
* by latitude being set ("geo") or gridX being set ("grid");
* otherwise returns the default of "none".
*
* @return location type (string)
*/
public String locType() {
String l = get(LATITUDE, null);
String x = get(GRID_X, null);
String def = l != null ? LOC_TYPE_GEO : (x != null ? LOC_TYPE_GRID : LOC_TYPE_NONE);
return get(LOC_TYPE, def);
}
/**
* Sets the location type (geo or grid) for the element in
* the Topology View. If null is passed, it will default to "geo".
*
* @param locType the UI type; null for default
* @return self
*/
public BasicElementConfig locType(String locType) {
String lt = Objects.equals(LOC_TYPE_GRID, locType) || Objects.equals(LOC_TYPE_GEO, locType)
? locType : LOC_TYPE_NONE;
return (BasicElementConfig) setOrClear(LOC_TYPE, lt);
}
private boolean doubleIsZero(double value) {
return value >= -ZERO_THRESHOLD && value <= ZERO_THRESHOLD;
}
/**
* Returns true if the geographical coordinates (latitude and longitude)
* are set on this element; false otherwise.
*
* @return true if geo-coordinates are set; false otherwise
*/
public boolean geoCoordsSet() {
return !doubleIsZero(latitude()) || !doubleIsZero(longitude());
}
/**
* Returns element latitude.
*
* @return element latitude; 0.0 if (possibly) not set
* @see #geoCoordsSet()
*/
public double latitude() {
return get(LATITUDE, DEFAULT_COORD);
}
/**
* Sets the element latitude.
*
* @param latitude new latitude; null to clear
* @return self
*/
public BasicElementConfig latitude(Double latitude) {
return (BasicElementConfig) setOrClear(LATITUDE, latitude);
}
/**
* Returns element longitude.
*
* @return element longitude; 0 if (possibly) not set
* @see #geoCoordsSet()
*/
public double longitude() {
return get(LONGITUDE, DEFAULT_COORD);
}
/**
* Sets the element longitude.
*
* @param longitude new longitude; null to clear
* @return self
*/
public BasicElementConfig longitude(Double longitude) {
return (BasicElementConfig) setOrClear(LONGITUDE, longitude);
}
/**
* Returns true if the grid coordinates (gridY and gridX) are set on
* this element, i.e. if locType is set to 'grid'; false otherwise.
*
* @return true if grid coordinates are set; false otherwise.
*/
public boolean gridCoordsSet() {
return Objects.equals(locType(), LOC_TYPE_GRID);
}
/**
* Returns element grid y-coordinate.
*
* @return element y-coordinate
*/
public double gridY() {
return get(GRID_Y, DEFAULT_COORD);
}
/**
* Sets the element grid y-coordinate.
*
* @param y new y-coordinate; null to clear
* @return self
*/
public BasicElementConfig gridY(Double y) {
return (BasicElementConfig) setOrClear(GRID_Y, y);
}
/**
* Returns element grid x-coordinate.
*
* @return element x-coordinate
*/
public double gridX() {
return get(GRID_X, DEFAULT_COORD);
}
/**
* Sets the element grid x-coordinate.
*
* @param x new x-coordinate; null to clear
* @return self
*/
public BasicElementConfig gridX(Double x) {
return (BasicElementConfig) setOrClear(GRID_X, x);
}
/**
* Returns the element rack address.
*
* @return rack address; null if not set
*/
public String rackAddress() {
return get(RACK_ADDRESS, null);
}
/**
* Sets element rack address.
*
* @param address new rack address; null to clear
* @return self
*/
public BasicElementConfig rackAddress(String address) {
return (BasicElementConfig) setOrClear(RACK_ADDRESS, address);
}
/**
* Returns owner of the element.
*
* @return owner or null if not set
*/
public String owner() {
return get(OWNER, null);
}
/**
* Sets the owner of the element.
*
* @param owner new owner; null to clear
* @return self
*/
public BasicElementConfig owner(String owner) {
return (BasicElementConfig) setOrClear(OWNER, owner);
}
/**
* Returns set of roles assigned to the element.
*
* @return set of roles
*/
public Set roles() {
ImmutableSet.Builder roles = ImmutableSet.builder();
if (object.has(ROLES)) {
ArrayNode roleNodes = (ArrayNode) object.path(ROLES);
roleNodes.forEach(r -> roles.add(r.asText()));
}
return roles.build();
}
/**
* Sets the roles of the element.
*
* @param roles new roles; null to clear
* @return self
*/
public BasicElementConfig roles(Set roles) {
return (BasicElementConfig) setOrClear(ROLES, roles);
}
@Override
public boolean isValid() {
return isValidLength(NAME, NAME_MAX_LENGTH)
&& isValidLength(UI_TYPE, UI_TYPE_MAX_LENGTH)
&& isValidLength(LOC_TYPE, LOC_TYPE_MAX_LENGTH)
&& isValidLength(RACK_ADDRESS, RACK_ADDRESS_MAX_LENGTH)
&& isValidLength(OWNER, OWNER_MAX_LENGTH);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy