http://git-wip-us.apache.org/repos/asf/atlas/blob/b0ecc36a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/StarRating.java ---------------------------------------------------------------------- diff --git a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/StarRating.java b/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/StarRating.java deleted file mode 100644 index 26017d4..0000000 --- a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/StarRating.java +++ /dev/null @@ -1,113 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you 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 - * <p/> - * http://www.apache.org/licenses/LICENSE-2.0 - * <p/> - * 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.apache.atlas.ocf.properties; - -import com.fasterxml.jackson.annotation.JsonAutoDetect; -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; - -import java.io.Serializable; - -import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.NONE; -import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.PUBLIC_ONLY; - -/** - * A StarRating defines the rating that a user has placed against an asset. This ranges from not recommended - * through to five stars (excellent). - */ -@JsonAutoDetect(getterVisibility=PUBLIC_ONLY, setterVisibility=PUBLIC_ONLY, fieldVisibility=NONE) -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown=true) -public enum StarRating implements Serializable -{ - NOT_RECOMMENDED (0, "X", "Not recommended"), - ONE_STAR (1, "*", "Poor"), - TWO_STARS (2, "**", "Usable"), - THREE_STARS (3, "***", "Good"), - FOUR_STARS (4, "****", "Very Good"), - FIVE_STARS (5, "*****", "Excellent"); - - private static final long serialVersionUID = 1L; - - private int starRatingCode; - private String starRatingSymbol; - private String starRatingDescription; - - - /** - * Typical Constructor - */ - StarRating(int starRatingCode, String starRatingSymbol, String starRatingDescription) - { - /* - * Save the values supplied - */ - this.starRatingCode = starRatingCode; - this.starRatingSymbol = starRatingSymbol; - this.starRatingDescription = starRatingDescription; - } - - - /** - * Return the code for this enum instance - * - * @return int - star rating code - */ - public int getStarRatingCode() - { - return starRatingCode; - } - - - /** - * Return the default symbol for this enum instance. - * - * @return String - default symbol - */ - public String getStarRatingSymbol() - { - return starRatingSymbol; - } - - - /** - * Return the default description for the star rating for this enum instance. - * - * @return String - default description - */ - public String getStarRatingDescription() - { - return starRatingDescription; - } - - - /** - * Standard toString method. - * - * @return print out of variables in a JSON-style - */ - @Override - public String toString() - { - return "StarRating{" + - "starRatingCode=" + starRatingCode + - ", starRatingSymbol='" + starRatingSymbol + '\'' + - ", starRatingDescription='" + starRatingDescription + '\'' + - '}'; - } -} \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/atlas/blob/b0ecc36a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/VirtualConnection.java ---------------------------------------------------------------------- diff --git a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/VirtualConnection.java b/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/VirtualConnection.java deleted file mode 100644 index 5deb6eb..0000000 --- a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/VirtualConnection.java +++ /dev/null @@ -1,152 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you 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 - * <p/> - * http://www.apache.org/licenses/LICENSE-2.0 - * <p/> - * 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.apache.atlas.ocf.properties; - - -/** - * A virtual connection is for an asset that provides data by delegating requests to one or more other connections. - * it maintains a list of the connections that are used by its asset. These are referred to as embedded connections. - */ -public class VirtualConnection extends Connection -{ - /* - * Attributes of a virtual connection - */ - protected EmbeddedConnections embeddedConnections = null; - - - /** - * Typical Constructor - * - * @param parentAsset - descriptor for parent asset - * @param type - details of the metadata type for this properties object - * @param guid - String - unique id - * @param url - String - URL - * @param classifications - enumeration of classifications - * @param qualifiedName - unique name - * @param additionalProperties - additional properties for the referenceable object - * @param meanings - list of glossary terms (summary) - * @param displayName - consumable name - * @param description - stored description property for the connection. - * @param connectorType - connector type to copy - * @param endpoint - endpoint properties - * @param securedProperties - typically user credentials for the connection - * @param embeddedConnections - the embedded connections for this virtual connection. - */ - public VirtualConnection(AssetDescriptor parentAsset, - ElementType type, - String guid, - String url, - Classifications classifications, - String qualifiedName, - AdditionalProperties additionalProperties, - Meanings meanings, - String displayName, - String description, - ConnectorType connectorType, - Endpoint endpoint, - AdditionalProperties securedProperties, - EmbeddedConnections embeddedConnections) - { - super(parentAsset, - type, - guid, - url, - classifications, - qualifiedName, - additionalProperties, - meanings, - displayName, - description, - connectorType, - endpoint, - securedProperties); - - this.embeddedConnections = embeddedConnections; - } - - /** - * Copy/clone constructor. - * - * @param parentAsset - descriptor for parent asset - * @param templateVirtualConnection - element to copy - */ - public VirtualConnection(AssetDescriptor parentAsset, VirtualConnection templateVirtualConnection) - { - /* - * Save the parent asset description. - */ - super(parentAsset, templateVirtualConnection); - - /* - * Extract additional information from the template if available - */ - if (templateVirtualConnection != null) - { - EmbeddedConnections templateEmbeddedConnections = templateVirtualConnection.getEmbeddedConnections(); - - if (templateEmbeddedConnections != null) - { - /* - * Ensure comment replies has this object's parent asset, not the template's. - */ - embeddedConnections = templateEmbeddedConnections.cloneIterator(parentAsset); - } - } - } - - - /** - * Return the enumeration of embedded connections for this virtual connection. - * - * @return EmbeddedConnections - */ - public EmbeddedConnections getEmbeddedConnections() - { - if (embeddedConnections == null) - { - return embeddedConnections; - } - else - { - return embeddedConnections.cloneIterator(super.getParentAsset()); - } - } - - - /** - * Standard toString method. - * - * @return print out of variables in a JSON-style - */ - @Override - public String toString() - { - return "VirtualConnection{" + - "embeddedConnections=" + embeddedConnections + - ", securedProperties=" + securedProperties + - ", qualifiedName='" + qualifiedName + '\'' + - ", additionalProperties=" + additionalProperties + - ", meanings=" + meanings + - ", type=" + type + - ", guid='" + guid + '\'' + - ", url='" + url + '\'' + - '}'; - } -} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/atlas/blob/b0ecc36a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/AdditionalProperties.java ---------------------------------------------------------------------- diff --git a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/AdditionalProperties.java b/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/AdditionalProperties.java deleted file mode 100644 index 6a23a47..0000000 --- a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/AdditionalProperties.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you 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 - * <p/> - * http://www.apache.org/licenses/LICENSE-2.0 - * <p/> - * 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.apache.atlas.ocf.properties.beans; - -import com.fasterxml.jackson.annotation.JsonAutoDetect; -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; - -import java.util.HashMap; -import java.util.Map; - -import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.NONE; -import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.PUBLIC_ONLY; - -/** - * The AdditionalProperties bean extends the AdditionalProperties from the properties package with a default constructor and - * setter methods. This means it can be used for REST calls and other JSON based functions. - */ -@JsonAutoDetect(getterVisibility=PUBLIC_ONLY, setterVisibility=PUBLIC_ONLY, fieldVisibility=NONE) -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown=true) -public class AdditionalProperties extends org.apache.atlas.ocf.properties.AdditionalProperties -{ - - /** - * Default constructor - */ - public AdditionalProperties() - { - super(null); - } - - - /** - * Set up the additional properties. - * - * @param additionalProperties - property map - */ - public void setAdditionalProperties(Map<String, Object> additionalProperties) - { - super.additionalProperties = additionalProperties; - } - - - /** - * Copy/clone Constructor for additional properties that are connected to an asset. - * - * @param templateProperties - template object to copy. - */ - public AdditionalProperties(AdditionalProperties templateProperties) - { - super(null, templateProperties); - } -} http://git-wip-us.apache.org/repos/asf/atlas/blob/b0ecc36a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/Connection.java ---------------------------------------------------------------------- diff --git a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/Connection.java b/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/Connection.java deleted file mode 100644 index 465255f..0000000 --- a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/Connection.java +++ /dev/null @@ -1,181 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you 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 - * <p/> - * http://www.apache.org/licenses/LICENSE-2.0 - * <p/> - * 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.apache.atlas.ocf.properties.beans; - -import com.fasterxml.jackson.annotation.JsonAutoDetect; -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; - -import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.NONE; -import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.PUBLIC_ONLY; - -/** - * The Connection bean extends the Connection from the properties package with a default constructor and - * setter methods. This means it can be used for REST calls and other JSON based functions. - */ -@JsonAutoDetect(getterVisibility=PUBLIC_ONLY, setterVisibility=PUBLIC_ONLY, fieldVisibility=NONE) -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown=true) -public class Connection extends org.apache.atlas.ocf.properties.Connection -{ - /** - * Default constructor sets the Connection properties to null. - */ - public Connection() - { - super(null); - } - - - /** - * Copy/clone Constructor to return a copy of a connection object that is not connected to an asset. - * - * @param templateConnection - Connection to copy - */ - public Connection(Connection templateConnection) - { - /* - * Set parentAsset to null - */ - super(templateConnection); - } - - - /** - * Copy/clone Constructor to return a copy of a connection object that is not connected to an asset. - * - * @param templateConnection - Connection to copy - */ - public Connection(org.apache.atlas.ocf.properties.Connection templateConnection) - { - /* - * Set parentAsset to null - */ - super(templateConnection); - } - - - /** - * Set up the type of this element. - * - * @param type - element type proprerties - */ - public void setType(ElementType type) - { - super.type = type; - } - - - /** - * Set up the guid for the element. - * - * @param guid - String unique identifier - */ - public void setGUID(String guid) - { - super.guid = guid; - } - - - /** - * Set up the URL of this element. - * - * @param url - String - */ - public void setURL(String url) - { - super.url = url; - } - - - /** - * Set up the fully qualified name. - * - * @param qualifiedName - String name - */ - public void setQualifiedName(String qualifiedName) - { - super.qualifiedName = qualifiedName; - } - - - /** - * Set up additional properties. - * - * @param additionalProperties - Additional properties object - */ - public void setAdditionalProperties(AdditionalProperties additionalProperties) - { - super.additionalProperties = additionalProperties; - } - - - /** - * Set up the display name for UIs and reports. - * - * @param displayName - String name - */ - public void setDisplayName(String displayName) - { - super.displayName = displayName; - } - - - /** - * Set up description of the element. - * - * @param description - String - */ - public void setDescription(String description) - { - super.description = description; - } - - - /** - * Set up the connector type properties for this Connection. - * - * @param connectorType - ConnectorType properties object - */ - public void setConnectorType(ConnectorType connectorType) - { - super.connectorType = connectorType; - } - - - /** - * Set up the endpoint properties for this Connection. - * - * @param endpoint - Endpoint properties object - */ - public void setEndpoint(Endpoint endpoint) - { - super.endpoint = endpoint; - } - - - /** - * Set up the secured properties for this Connection. - * - * @param securedProperties - properties that contain secret information such as log on information. - */ - public void setSecuredProperties(AdditionalProperties securedProperties) - { - super.securedProperties = securedProperties; - } -} http://git-wip-us.apache.org/repos/asf/atlas/blob/b0ecc36a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/ConnectorType.java ---------------------------------------------------------------------- diff --git a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/ConnectorType.java b/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/ConnectorType.java deleted file mode 100644 index 7e16440..0000000 --- a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/ConnectorType.java +++ /dev/null @@ -1,143 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you 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 - * <p/> - * http://www.apache.org/licenses/LICENSE-2.0 - * <p/> - * 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.apache.atlas.ocf.properties.beans; - -import com.fasterxml.jackson.annotation.JsonAutoDetect; -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; - -import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.NONE; -import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.PUBLIC_ONLY; - -/** - * The Connection bean extends the Connection from the properties package with a default constructor and - * setter methods. This means it can be used for REST calls and other JSON based functions. - */ -@JsonAutoDetect(getterVisibility=PUBLIC_ONLY, setterVisibility=PUBLIC_ONLY, fieldVisibility=NONE) -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown=true) -public class ConnectorType extends org.apache.atlas.ocf.properties.ConnectorType -{ - /** - * Default constructor - */ - public ConnectorType() - { - super(null); - } - - - /** - * Copy/clone constructor for a connectorType that is not connected to an asset (either directly or indirectly). - * - * @param templateConnectorType - template object to copy. - */ - public ConnectorType(ConnectorType templateConnectorType) - { - super(templateConnectorType); - } - - - /** - * Set up the type of this element. - * - * @param type - element type proprerties - */ - public void setType(ElementType type) - { - super.type = type; - } - - - /** - * Set up the guid for the element. - * - * @param guid - String unique identifier - */ - public void setGUID(String guid) - { - super.guid = guid; - } - - - /** - * Set up the URL of this element. - * - * @param url - String - */ - public void setURL(String url) - { - super.url = url; - } - - - /** - * Set up the fully qualified name. - * - * @param qualifiedName - String name - */ - public void setQualifiedName(String qualifiedName) - { - super.qualifiedName = qualifiedName; - } - - - /** - * Set up additional properties. - * - * @param additionalProperties - Additional properties object - */ - public void setAdditionalProperties(AdditionalProperties additionalProperties) - { - super.additionalProperties = additionalProperties; - } - - - /** - * Set up the display name for UIs and reports. - * - * @param displayName - String name - */ - public void setDisplayName(String displayName) - { - super.displayName = displayName; - } - - - /** - * Set up description of the element. - * - * @param description - String - */ - public void setDescription(String description) - { - super.description = description; - } - - - /** - * The name of the connector provider class name. - * - * @param connectorProviderClassName - String class name - */ - public void setConnectorProviderClassName(String connectorProviderClassName) - { - super.connectorProviderClassName = connectorProviderClassName; - } - -} http://git-wip-us.apache.org/repos/asf/atlas/blob/b0ecc36a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/ElementType.java ---------------------------------------------------------------------- diff --git a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/ElementType.java b/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/ElementType.java deleted file mode 100644 index 6fb4683..0000000 --- a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/ElementType.java +++ /dev/null @@ -1,134 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you 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 - * <p/> - * http://www.apache.org/licenses/LICENSE-2.0 - * <p/> - * 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.apache.atlas.ocf.properties.beans; - -import com.fasterxml.jackson.annotation.JsonAutoDetect; -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import org.apache.atlas.ocf.properties.ElementOrigin; - -import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.NONE; -import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.PUBLIC_ONLY; - -/** - * The ElementType bean extends the ElementType from the properties package with a default constructor and - * setter methods. This means it can be used for REST calls and other JSON based functions. - */ -@JsonAutoDetect(getterVisibility=PUBLIC_ONLY, setterVisibility=PUBLIC_ONLY, fieldVisibility=NONE) -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown=true) -public class ElementType extends org.apache.atlas.ocf.properties.ElementType -{ - /** - * Default constructor - */ - public ElementType() - { - super(null); - elementOrigin = ElementOrigin.CONFIGURATION; - } - - - /** - * Copy/clone constructor - * - * @param templateType - type to clone - */ - public ElementType(ElementType templateType) - { - super(templateType); - } - - - /** - * Set up the unique identifier for the element's type. - * - * @param elementTypeId - String identifier - */ - public void setElementTypeId(String elementTypeId) - { - super.elementTypeId = elementTypeId; - } - - - /** - * Set up the name of this element's type - * - * @param elementTypeName - String name - */ - public void setElementTypeName(String elementTypeName) - { - super.elementTypeName = elementTypeName; - } - - - /** - * Set up the version number for this element's type - * - * @param elementTypeVersion - version number for the element type. - */ - public void setElementTypeVersion(long elementTypeVersion) - { - super.elementTypeVersion = elementTypeVersion; - } - - - /** - * - * @param elementTypeDescription - set up the description for this element's type - */ - public void setElementTypeDescription(String elementTypeDescription) - { - super.elementTypeDescription = elementTypeDescription; - } - - - /** - * the URL of the server where the element was retrieved from. Typically this is - * a server where the OMAS interfaces are activated. If no URL is known for the server then null is returned. - * - * @param elementAccessServiceURL - URL of the server - */ - public void setElementAccessServiceURL(String elementAccessServiceURL) - { - super.elementSourceServer = elementAccessServiceURL; - } - - - /** - * Set up the details of this element's origin. - * - * @param elementOrigin - see ElementOrigin enum - */ - public void setElementOrigin(ElementOrigin elementOrigin) - { - super.elementOrigin = elementOrigin; - } - - - /** - * Set up the OMRS identifier for the metadata collection that is managed by the repository - * where the element originates (its home repository). - * - * @param elementHomeMetadataCollectionId - String unique identifier for the home metadata repository - */ - public void setElementHomeMetadataCollectionId(String elementHomeMetadataCollectionId) - { - super.elementHomeMetadataCollectionId = elementHomeMetadataCollectionId; - } -} http://git-wip-us.apache.org/repos/asf/atlas/blob/b0ecc36a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/Endpoint.java ---------------------------------------------------------------------- diff --git a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/Endpoint.java b/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/Endpoint.java deleted file mode 100644 index f86c01c..0000000 --- a/om-fwk-ocf/src/main/java/org/apache/atlas/ocf/properties/beans/Endpoint.java +++ /dev/null @@ -1,164 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you 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 - * <p/> - * http://www.apache.org/licenses/LICENSE-2.0 - * <p/> - * 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.apache.atlas.ocf.properties.beans; - -import com.fasterxml.jackson.annotation.JsonAutoDetect; -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; - -import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.NONE; -import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.PUBLIC_ONLY; - -/** - * The Endpoint bean extends the Endpoint from the properties package with a default constructor and - * setter methods. This means it can be used for REST calls and other JSON based functions. - */ -@JsonAutoDetect(getterVisibility=PUBLIC_ONLY, setterVisibility=PUBLIC_ONLY, fieldVisibility=NONE) -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonIgnoreProperties(ignoreUnknown=true) -public class Endpoint extends org.apache.atlas.ocf.properties.Endpoint -{ - /** - * Default constructor - */ - public Endpoint() - { - super(null); - } - - - /** - * Copy/clone constructor for an Endpoint not connected to an asset. - * - * @param templateEndpoint - template object to copy. - */ - public Endpoint(Endpoint templateEndpoint) - { - super(templateEndpoint); - } - - - /** - * Set up the type of this element. - * - * @param type - element type proprerties - */ - public void setType(ElementType type) - { - super.type = type; - } - - - /** - * Set up the guid for the element. - * - * @param guid - String unique identifier - */ - public void setGUID(String guid) - { - super.guid = guid; - } - - - /** - * Set up the URL of this element. - * - * @param url - String - */ - public void setURL(String url) - { - super.url = url; - } - - - /** - * Set up the fully qualified name. - * - * @param qualifiedName - String name - */ - public void setQualifiedName(String qualifiedName) - { - super.qualifiedName = qualifiedName; - } - - - /** - * Set up additional properties. - * - * @param additionalProperties - Additional properties object - */ - public void setAdditionalProperties(AdditionalProperties additionalProperties) - { - super.additionalProperties = additionalProperties; - } - - - /** - * Set up the display name for UIs and reports. - * - * @param displayName - String name - */ - public void setDisplayName(String displayName) - { - super.displayName = displayName; - } - - - /** - * Set up description of the element. - * - * @param description - String - */ - public void setDescription(String description) - { - super.description = description; - } - - - /** - * Set up the network address of the Endpoint. - * - * @param address - String resource name - */ - public void setAddress(String address) - { - super.address = address; - } - - - /** - * Set up the protocol to use for this Endpoint - * - * @param protocol - String protocol name - */ - public void setProtocol(String protocol) - { - super.protocol = protocol; - } - - - /** - * Set up the encryption method used on this Endpoint. - * - * @param encryptionMethod - String name - */ - public void setEncryptionMethod(String encryptionMethod) - { - super.encryptionMethod = encryptionMethod; - } -} http://git-wip-us.apache.org/repos/asf/atlas/blob/b0ecc36a/omag-api/pom.xml ---------------------------------------------------------------------- diff --git a/omag-api/pom.xml b/omag-api/pom.xml deleted file mode 100644 index b188a99..0000000 --- a/omag-api/pom.xml +++ /dev/null @@ -1,121 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - ~ Licensed to the Apache Software Foundation (ASF) under one - ~ or more contributor license agreements. See the NOTICE file - ~ distributed with this work for additional information - ~ regarding copyright ownership. The ASF licenses this file - ~ to you 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. - --> - -<project xmlns="http://maven.apache.org/POM/4.0.0" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> - - <modelVersion>4.0.0</modelVersion> - - <parent> - <artifactId>apache-atlas</artifactId> - <groupId>org.apache.atlas</groupId> - <version>1.0.0</version> - </parent> - - <artifactId>omag-api</artifactId> - - <name>Open Metadata and Governance (OMAG) Server APIs</name> - <description>Open Metadata and Governance (OMAG) server interfaces for managing the open metadata and governance - functions running inside a server. - </description> - - <packaging>jar</packaging> - - <dependencies> - - <dependency> - <groupId>org.springframework.boot</groupId> - <artifactId>spring-boot-starter</artifactId> - <version>1.5.7.RELEASE</version> - </dependency> - - <dependency> - <groupId>org.springframework.boot</groupId> - <artifactId>spring-boot-starter-web</artifactId> - <version>1.5.7.RELEASE</version> - </dependency> - - <dependency> - <groupId>commons-collections</groupId> - <artifactId>commons-collections</artifactId> - </dependency> - - <dependency> - <groupId>commons-io</groupId> - <artifactId>commons-io</artifactId> - </dependency> - - <dependency> - <groupId>com.fasterxml.jackson.jaxrs</groupId> - <artifactId>jackson-jaxrs-base</artifactId> - <version>${jackson.version}</version> - </dependency> - - <dependency> - <groupId>com.fasterxml.jackson.jaxrs</groupId> - <artifactId>jackson-jaxrs-json-provider</artifactId> - <version>${jackson.version}</version> - </dependency> - - <dependency> - <groupId>javax.inject</groupId> - <artifactId>javax.inject</artifactId> - <version>${javax-inject.version}</version> - </dependency> - - <dependency> - <groupId>org.testng</groupId> - <artifactId>testng</artifactId> - <scope>test</scope> - </dependency> - - <dependency> - <groupId>org.apache.atlas</groupId> - <artifactId>om-fwk-ocf</artifactId> - <version>1.0.0</version> - </dependency> - - <dependency> - <groupId>org.apache.atlas</groupId> - <artifactId>omrs</artifactId> - <version>1.0.0</version> - </dependency> - - - - </dependencies> - - <build> - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-jar-plugin</artifactId> - <version>2.4</version> - <executions> - <execution> - <goals> - <goal>test-jar</goal> - </goals> - </execution> - </executions> - </plugin> - </plugins> - </build> -</project> http://git-wip-us.apache.org/repos/asf/atlas/blob/b0ecc36a/omag-api/src/main/java/org/apache/atlas/omag/admin/LocalRepositoryMode.java ---------------------------------------------------------------------- diff --git a/omag-api/src/main/java/org/apache/atlas/omag/admin/LocalRepositoryMode.java b/omag-api/src/main/java/org/apache/atlas/omag/admin/LocalRepositoryMode.java deleted file mode 100644 index ed6c2d9..0000000 --- a/omag-api/src/main/java/org/apache/atlas/omag/admin/LocalRepositoryMode.java +++ /dev/null @@ -1,102 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you 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 - * <p/> - * http://www.apache.org/licenses/LICENSE-2.0 - * <p/> - * 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.apache.atlas.omag.admin; - -import java.io.Serializable; - -/** - * LocalRepositoryMode defines the mode that the local repository will operate in. - */ -public enum LocalRepositoryMode implements Serializable -{ - NO_LOCAL_REPOSITORY (0, "No Local repository", "There is no local repository so all of the metadata " + - "passed through the enterprise access " + - "layer to the open metadata access services comes from " + - "peer repositories from the cohort(s) that this repository " + - "is registered with."), - IN_MEMORY_REPOSITORY (1, "In memory repository", "The local repository is an in memory repository that does" + - "not save metadata between each run of the server."), - LOCAL_GRAPH_REPOSITORY (2, "Local graph repository", "The built-in graph database is in use. Metadata can be stored " + - "and retrieved from this graph database. " + - "This metadata can be combined with metadata from " + - "peer repositories from the cohort(s) that this repository " + - "is registered with."), - REPOSITORY_PROXY (3, "Repository proxy", "The local repository is implemented by a service that is " + - "external to the local server. Metadata can be stored " + - "and retrieved from this repository. This metadata can be " + - "combined with metadata from peer repositories from the " + - "cohort(s) that this repository is registered with."); - - private static final long serialVersionUID = 1L; - - private int typeCode; - private String typeName; - private String typeDescription; - - - /** - * Default Constructor - * - * @param typeCode - ordinal for this enum - * @param typeName - symbolic name for this enum - * @param typeDescription - short description for this enum - */ - LocalRepositoryMode(int typeCode, String typeName, String typeDescription) - { - /* - * Save the values supplied - */ - this.typeCode = typeCode; - this.typeName = typeName; - this.typeDescription = typeDescription; - } - - - /** - * Return the code for this enum instance - * - * @return int - type code - */ - public int getTypeCode() - { - return typeCode; - } - - - /** - * Return the default name for this enum instance. - * - * @return String - default name - */ - public String getTypeName() - { - return typeName; - } - - - /** - * Return the default description for the type for this enum instance. - * - * @return String - default description - */ - public String getTypeDescription() - { - return typeDescription; - } -} http://git-wip-us.apache.org/repos/asf/atlas/blob/b0ecc36a/omag-api/src/main/java/org/apache/atlas/omag/admin/OMAGServerAdministration.java ---------------------------------------------------------------------- diff --git a/omag-api/src/main/java/org/apache/atlas/omag/admin/OMAGServerAdministration.java b/omag-api/src/main/java/org/apache/atlas/omag/admin/OMAGServerAdministration.java deleted file mode 100644 index dd19018..0000000 --- a/omag-api/src/main/java/org/apache/atlas/omag/admin/OMAGServerAdministration.java +++ /dev/null @@ -1,377 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you 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 - * <p/> - * http://www.apache.org/licenses/LICENSE-2.0 - * <p/> - * 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.apache.atlas.omag.admin; - - -import org.apache.atlas.ocf.properties.beans.Connection; -import org.apache.atlas.omag.configuration.properties.AccessServiceConfig; -import org.apache.atlas.omag.configuration.properties.OMAGServerConfig; -import org.apache.atlas.omag.ffdc.exception.OMAGConfigurationErrorException; -import org.apache.atlas.omag.ffdc.exception.OMAGInvalidParameterException; -import org.apache.atlas.omag.ffdc.exception.OMAGNotAuthorizedException; -import org.apache.atlas.omrs.admin.properties.CohortConfig; -import org.apache.atlas.omrs.admin.properties.EnterpriseAccessConfig; -import org.apache.atlas.omrs.admin.properties.LocalRepositoryConfig; - -import java.util.List; - -/** - * OMAGServerAdministration defines the administrative interface for an Open Metadata and Governance (OMAG) Server. - * It is used to create both the Java client and the RESTful server-side implementation. It provides all of the - * configuration properties for the Open Metadata Access Services (OMASs) and delegates administration requests - * to the Open Metadata Repository Services (OMRS). - * - * <p> - * There are four types of operations supported by OMAGServerAdministration: - * </p> - * <ul> - * <li> - * Basic configuration - these methods use the minimum of configuration information to run the - * server using default properties. - * </li> - * <li> - * Advanced Configuration - provides access to all configuration properties to provide - * fine-grained control of the server. - * </li> - * <li> - * Initialization and shutdown - these methods control the initialization and shutdown of the - * open metadata and governance services based on the supplied configuration. - * </li> - * <li> - * Operational status and control - these methods query the status of the open metadata and governance - * services as well as the audit log. - * </li> - * </ul> - */ -public interface OMAGServerAdministration -{ - /* - * ============================================================= - * Configure server - basic options using defaults - */ - - /** - * Set up the root URL for this server that is used to construct full URL paths to calls for - * this server's REST interfaces. The default value is "localhost:8080". - * - * @param userId - user that is issuing the request. - * @param serverName - local server name. - * @param serverURLRoot - String url. - * @throws OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command. - * @throws OMAGInvalidParameterException - invalid serverName or serverURLRoot parameter. - */ - void setServerURLRoot(String userId, - String serverName, - String serverURLRoot) throws OMAGNotAuthorizedException, - OMAGInvalidParameterException; - - - /** - * Set up the descriptive type of the server. This value is added to distributed events to - * make it easier to understand the source of events. The default value is "Open Metadata and Governance Server". - * - * @param userId - user that is issuing the request. - * @param serverName - local server name. - * @param serverType - short description for the type of server. - * @throws OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command. - * @throws OMAGInvalidParameterException - invalid serverName or serverType parameter. - */ - void setServerType(String userId, - String serverName, - String serverType) throws OMAGNotAuthorizedException, - OMAGInvalidParameterException; - - - /** - * Set up the name of the organization that is running this server. This value is added to distributed events to - * make it easier to understand the source of events. The default value is null. - * - * @param userId - user that is issuing the request. - * @param serverName - local server name. - * @param organizationName - String name of the organization. - * @throws OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command. - * @throws OMAGInvalidParameterException - invalid serverName or organizationName parameter. - */ - void setOrganizationName(String userId, - String serverName, - String organizationName) throws OMAGNotAuthorizedException, - OMAGInvalidParameterException; - - /** - * Set an upper limit in the page size that can be requested on a REST call to the server. The default - * value is 1000. - * - * @param userId - user that is issuing the request. - * @param serverName - local server name. - * @param maxPageSize - max number of elements that can be returned on a request. - * @throws OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command. - * @throws OMAGInvalidParameterException - invalid serverName or maxPageSize parameter. - */ - void setMaxPageSize(String userId, - String serverName, - int maxPageSize) throws OMAGNotAuthorizedException, - OMAGInvalidParameterException; - - - /** - * Set up whether the access services should be enabled or not. This is controlled by the serviceMode. - * The default is serviceMode=enabled for all access services that are installed into this server and - * serviceMode=disabled for those services that are not installed. The configuration properties - * for each access service can be changed from their default using setAccessServicesConfig operation. - * - * @param userId - user that is issuing the request. - * @param serverName - local server name. - * @param serviceMode - OMAGServiceMode enum. - * @throws OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command. - * @throws OMAGInvalidParameterException - invalid serverName or serviceMode parameter. - */ - void setAccessServicesMode(String userId, - String serverName, - OMAGServiceMode serviceMode) throws OMAGNotAuthorizedException, - OMAGInvalidParameterException; - - - /** - * Set up the type of local repository. There are three choices: No local Repository, Local Graph Repository - * and Repository Proxy. The default is No Local Repository. If the local repository mode is set to - * Repository Proxy then it is necessary to provide the connection to the local repository using the - * setRepositoryProxyConnection operation. - * - * @param userId - user that is issuing the request. - * @param serverName - local server name. - * @param localRepositoryMode - LocalRepositoryMode enum - NO_LOCAL_REPOSITORY, LOCAL_GRAPH_REPOSITORY - * or REPOSITORY_PROXY. - * @throws OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command. - * @throws OMAGInvalidParameterException - invalid serverName or localRepositoryMode parameter. - */ - void setLocalRepositoryMode(String userId, - String serverName, - LocalRepositoryMode localRepositoryMode) throws OMAGNotAuthorizedException, - OMAGInvalidParameterException; - - - /** - * Provide the connection to the local repository - used when the local repository mode is set to repository proxy. - * - * @param userId - user that is issuing the request. - * @param serverName - local server name. - * @param repositoryProxyConnection - connection to the OMRS repository connector. - * @throws OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command. - * @throws OMAGInvalidParameterException - invalid serverName or repositoryProxyConnection parameter - * @throws OMAGConfigurationErrorException - the local repository mode has not been set - */ - void setRepositoryProxyConnection(String userId, - String serverName, - Connection repositoryProxyConnection) throws OMAGNotAuthorizedException, - OMAGInvalidParameterException, - OMAGConfigurationErrorException; - - - /** - * Provide the connection to the local repository's event mapper if needed. The default value is null which - * means no event mapper. An event mapper is needed if the local repository has additional APIs that can change - * the metadata in the repository without going through the open metadata and governance services. - * - * @param userId - user that is issuing the request. - * @param serverName - local server name. - * @param localRepositoryEventMapper - connection to the OMRS repository event mapper. - * @throws OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command. - * @throws OMAGInvalidParameterException - invalid serverName or localRepositoryEventMapper parameter. - * @throws OMAGConfigurationErrorException - the local repository mode has not been set - */ - void setLocalRepositoryEventMapper(String userId, - String serverName, - Connection localRepositoryEventMapper) throws OMAGNotAuthorizedException, - OMAGInvalidParameterException, - OMAGConfigurationErrorException; - - - /** - * Set up the mode for an open metadata repository cohort. This is a group of open metadata repositories that - * are sharing metadata. An OMAG server can connect to zero, one or more cohorts. Each cohort needs - * a unique name. The members of the cohort use a shared topic to exchange registration information and - * events related to changes in their supported metadata types and instances. They are also able to - * query each other's metadata directly through REST calls. - * - * @param userId - user that is issuing the request. - * @param serverName - local server name. - * @param cohortName - name of the cohort. - * @param serviceMode - OMAGServiceMode enum - ENABLED or DISABLED. - * @throws OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command. - * @throws OMAGInvalidParameterException - invalid serverName, cohortName or serviceMode parameter. - */ - void setCohortMode(String userId, - String serverName, - String cohortName, - OMAGServiceMode serviceMode) throws OMAGNotAuthorizedException, - OMAGInvalidParameterException; - - - /* - * ============================================================= - * Configure server - advanced options overriding defaults - */ - - - /** - * Set up the configuration for all of the open metadata access services (OMASs). This overrides - * the current values. - * - * @param userId - user that is issuing the request. - * @param serverName - local server name. - * @param accessServicesConfig - list of configuration properties for each access service. - * @throws OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command. - * @throws OMAGInvalidParameterException - invalid serverName or accessServicesConfig parameter. - */ - void setAccessServicesConfig(String userId, - String serverName, - List<AccessServiceConfig> accessServicesConfig) throws OMAGNotAuthorizedException, - OMAGInvalidParameterException; - - - /** - * Set up the configuration for the local repository. This overrides the current values. - * - * @param userId - user that is issuing the request. - * @param serverName - local server name. - * @param localRepositoryConfig - configuration properties for the local repository. - * @throws OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command. - * @throws OMAGInvalidParameterException - invalid serverName or localRepositoryConfig parameter. - */ - void setLocalRepositoryConfig(String userId, - String serverName, - LocalRepositoryConfig localRepositoryConfig) throws OMAGNotAuthorizedException, - OMAGInvalidParameterException; - - - /** - * Set up the configuration that controls the enterprise repository services. These services are part - * of the Open Metadata Repository Services (OMRS). They provide federated queries and federated event - * notifications that cover metadata from the local repository plus any repositories connected via - * open metadata repository cohorts. - * - * @param userId - user that is issuing the request - * @param serverName - local server name - * @param enterpriseAccessConfig - enterprise repository services configuration properties. - * @throws OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command. - * @throws OMAGInvalidParameterException - invalid serverName or enterpriseAccessConfig parameter. - */ - void setEnterpriseAccessConfig(String userId, - String serverName, - EnterpriseAccessConfig enterpriseAccessConfig) throws OMAGNotAuthorizedException, - OMAGInvalidParameterException; - - - /** - * Set up the configuration properties for a cohort. This may reconfigure an existing cohort or create a - * cohort. Use setCohortMode to delete a cohort. - * - * @param userId - user that is issuing the request - * @param serverName - local server name - * @param cohortName - name of the cohort - * @param cohortConfig - configuration for the cohort - * @throws OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command. - * @throws OMAGInvalidParameterException - invalid serverName, cohortName or cohortConfig parameter. - */ - void setCohortConfig(String userId, - String serverName, - String cohortName, - CohortConfig cohortConfig) throws OMAGNotAuthorizedException, - OMAGInvalidParameterException; - - - /* - * ============================================================= - * Query current configuration - */ - - - /** - * Return the complete set of configuration properties in use by the server. - * - * @param userId - user that is issuing the request - * @param serverName - local server name - * @return OMAGServerConfig properties - * @throws OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command. - * @throws OMAGInvalidParameterException - invalid serverName parameter. - */ - OMAGServerConfig getCurrentConfiguration(String userId, - String serverName) throws OMAGNotAuthorizedException, - OMAGInvalidParameterException; - - - /* - * ============================================================= - * Initialization and shutdown - */ - - /** - * Initialize the open metadata and governance services using the stored configuration information. - * - * @param userId - user that is issuing the request - * @param serverName - local server name - * @throws OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command. - * @throws OMAGInvalidParameterException - the server name is invalid - * @throws OMAGConfigurationErrorException - there is a problem using the supplied configuration - */ - void initialize (String userId, - String serverName) throws OMAGNotAuthorizedException, - OMAGInvalidParameterException, - OMAGConfigurationErrorException; - - - /** - * Initialize the open metadata and governance services using the supplied information. - * - * @param userId - user that is issuing the request - * @param configuration - properties used to initialize the services - * @param serverName - local server name - * @throws OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command. - * @throws OMAGInvalidParameterException - the serverName is invalid. - * @throws OMAGConfigurationErrorException - there is a problem using the supplied configuration - */ - void initialize (String userId, - String serverName, - OMAGServerConfig configuration) throws OMAGNotAuthorizedException, - OMAGInvalidParameterException, - OMAGConfigurationErrorException; - - - /** - * Terminate any open metadata and governance services. - * - * @param userId - user that is issuing the request - * @param serverName - local server name - * @param permanent - Is the server being shutdown permanently - if yes, the local server will unregister from - * its open metadata repository cohorts. - * @throws OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command. - * @throws OMAGInvalidParameterException - the serverName is invalid. - */ - void terminate (String userId, - String serverName, - boolean permanent) throws OMAGNotAuthorizedException, - OMAGInvalidParameterException; - - - /* - * ============================================================= - * Operational status and control - */ - - /* placeholder */ -} http://git-wip-us.apache.org/repos/asf/atlas/blob/b0ecc36a/omag-api/src/main/java/org/apache/atlas/omag/admin/OMAGServiceMode.java ---------------------------------------------------------------------- diff --git a/omag-api/src/main/java/org/apache/atlas/omag/admin/OMAGServiceMode.java b/omag-api/src/main/java/org/apache/atlas/omag/admin/OMAGServiceMode.java deleted file mode 100644 index 40f9fed..0000000 --- a/omag-api/src/main/java/org/apache/atlas/omag/admin/OMAGServiceMode.java +++ /dev/null @@ -1,87 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you 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 - * <p/> - * http://www.apache.org/licenses/LICENSE-2.0 - * <p/> - * 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.apache.atlas.omag.admin; - - -import java.io.Serializable; - -/** - * OMAGServiceMode sets up whether an open metadata and governance service (OMAS) is enabled or not. - */ -public enum OMAGServiceMode implements Serializable -{ - ENABLED (1, "Enabled", "The open metadata and governance service is available and running."), - DISABLED (0, "Disabled", "The open metadata and governance service is disabled."); - - private static final long serialVersionUID = 1L; - - private int typeCode; - private String typeName; - private String typeDescription; - - - /** - * Default Constructor - * - * @param typeCode - ordinal for this enum - * @param typeName - symbolic name for this enum - * @param typeDescription - short description for this enum - */ - OMAGServiceMode(int typeCode, String typeName, String typeDescription) - { - /* - * Save the values supplied - */ - this.typeCode = typeCode; - this.typeName = typeName; - this.typeDescription = typeDescription; - } - - - /** - * Return the code for this enum instance - * - * @return int - type code - */ - public int getTypeCode() - { - return typeCode; - } - - - /** - * Return the default name for this enum instance. - * - * @return String - default name - */ - public String getTypeName() - { - return typeName; - } - - - /** - * Return the default description for the type for this enum instance. - * - * @return String - default description - */ - public String getTypeDescription() - { - return typeDescription; - } -} http://git-wip-us.apache.org/repos/asf/atlas/blob/b0ecc36a/omag-api/src/main/java/org/apache/atlas/omag/admin/server/OMAGAccessServiceRegistration.java ---------------------------------------------------------------------- diff --git a/omag-api/src/main/java/org/apache/atlas/omag/admin/server/OMAGAccessServiceRegistration.java b/omag-api/src/main/java/org/apache/atlas/omag/admin/server/OMAGAccessServiceRegistration.java deleted file mode 100644 index aa9d80c..0000000 --- a/omag-api/src/main/java/org/apache/atlas/omag/admin/server/OMAGAccessServiceRegistration.java +++ /dev/null @@ -1,47 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you 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 - * <p/> - * http://www.apache.org/licenses/LICENSE-2.0 - * <p/> - * 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.apache.atlas.omag.admin.server; - -import org.apache.atlas.omag.configuration.registration.AccessServiceRegistration; - -import java.util.ArrayList; -import java.util.List; - -public class OMAGAccessServiceRegistration -{ - static private List<AccessServiceRegistration> accessServiceRegistrationList = new ArrayList<>(); - - - /* - * Register OMAS - */ - - public static synchronized void registerAccessService(AccessServiceRegistration registration) - { - if (registration != null) - { - accessServiceRegistrationList.add(registration); - } - } - - public static synchronized List<AccessServiceRegistration> getAccessServiceRegistrationList() - { - return accessServiceRegistrationList; - } - -}