io.nats.service.Endpoint Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jnats Show documentation
Show all versions of jnats Show documentation
Client library for working with the NATS messaging system.
// Copyright 2023 The NATS Authors
// 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 io.nats.service;
import io.nats.client.support.JsonSerializable;
import io.nats.client.support.JsonUtils;
import io.nats.client.support.JsonValue;
import io.nats.client.support.Validator;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import static io.nats.client.support.ApiConstants.*;
import static io.nats.client.support.JsonUtils.endJson;
import static io.nats.client.support.JsonValueUtils.readString;
import static io.nats.client.support.JsonValueUtils.readStringStringMap;
import static io.nats.client.support.Validator.validateIsRestrictedTerm;
/**
* Endpoint encapsulates the name, subject and metadata for a {@link ServiceEndpoint}.
* Endpoints can be used directly or as part of a group. {@link ServiceEndpoint} and {@link Group}
* Endpoint names and subjects are considered 'Restricted Terms' and must only contain A-Z, a-z, 0-9, '-' or '_'
* To create an Endpoint, either use a direct constructor or use the Endpoint builder
* via the static method builder() or new Endpoint.Builder() to get an instance.
*
*/
public class Endpoint implements JsonSerializable {
private static final String DEFAULT_QGROUP = "q";
private final String name;
private final String subject;
private final String queueGroup;
private final Map metadata;
/**
* Directly construct an Endpoint with a name, which becomes the subject
* @param name the name
*/
public Endpoint(String name) {
this(name, null, null, null, true);
}
/**
* Directly construct an Endpoint with a name, which becomes the subject, and metadata
* @param name the name
* @param metadata the metadata
*/
public Endpoint(String name, Map metadata) {
this(name, null, null, metadata, true);
}
/**
* Directly construct an Endpoint with a name and a subject
* @param name the name
* @param subject the subject
*/
public Endpoint(String name, String subject) {
this(name, subject, null, null, true);
}
/**
* Directly construct an Endpoint with a name, the subject, and metadata
* @param name the name
* @param subject the subject
* @param metadata the metadata
*/
public Endpoint(String name, String subject, Map metadata) {
this(name, subject, null, metadata, true);
}
/**
* Directly construct an Endpoint with a name, the subject, queueGroup and metadata
* @param name the name
* @param subject the subject
* @param queueGroup the queueGroup
* @param metadata the metadata
*/
public Endpoint(String name, String subject, String queueGroup, Map metadata) {
this(name, subject, queueGroup, metadata, true);
}
// internal use constructors
Endpoint(String name, String subject, String queueGroup, Map metadata, boolean validate) {
if (validate) {
this.name = validateIsRestrictedTerm(name, "Endpoint Name", true);
if (subject == null) {
this.subject = this.name;
}
else {
this.subject = Validator.validateSubjectTerm(subject, "Endpoint Subject", false);
}
if (queueGroup == null) {
this.queueGroup = DEFAULT_QGROUP;
}
else {
this.queueGroup = Validator.validateSubjectTerm(queueGroup, "Endpoint Queue Group", true);
}
}
else {
this.name = name;
this.subject = subject;
this.queueGroup = queueGroup;
}
this.metadata = metadata == null || metadata.isEmpty() ? null : metadata;
}
Endpoint(JsonValue vEndpoint) {
name = readString(vEndpoint, NAME);
subject = readString(vEndpoint, SUBJECT);
queueGroup = readString(vEndpoint, QUEUE_GROUP);
metadata = readStringStringMap(vEndpoint, METADATA);
}
Endpoint(Builder b) {
this(b.name, b.subject, b.queueGroup, b.metadata, true);
}
@Override
public String toJson() {
StringBuilder sb = JsonUtils.beginJson();
JsonUtils.addField(sb, NAME, name);
JsonUtils.addField(sb, SUBJECT, subject);
JsonUtils.addField(sb, QUEUE_GROUP, queueGroup);
JsonUtils.addField(sb, METADATA, metadata);
return endJson(sb).toString();
}
@Override
public String toString() {
return JsonUtils.toKey(getClass()) + toJson();
}
/**
* Get the name of the Endpoint
* @return the name
*/
public String getName() {
return name;
}
/**
* Get the subject of the Endpoint
* @return the subject
*/
public String getSubject() {
return subject;
}
/**
* Get the queueGroup for the Endpoint
* @return the queueGroup
*/
public String getQueueGroup() {
return queueGroup;
}
/**
* Get a copy of the metadata of the Endpoint
* @return the copy of metadata
*/
public Map getMetadata() {
return metadata == null ? null : new HashMap<>(metadata);
}
/**
* Get an instance of an Endpoint builder.
* @return the instance
*/
public static Builder builder() {
return new Builder();
}
/**
* Build an Endpoint using a fluent builder.
*/
public static class Builder {
private String name;
private String subject;
private String queueGroup = DEFAULT_QGROUP;
private Map metadata;
/**
* Construct the builder
*/
public Builder() {}
/**
* Copy the Endpoint, replacing all existing endpoint information.
* @param endpoint the endpoint to copy
* @return the Endpoint.Builder
*/
public Builder endpoint(Endpoint endpoint) {
return name(endpoint.getName())
.subject(endpoint.getSubject())
.queueGroup(endpoint.getQueueGroup())
.metadata(endpoint.getMetadata());
}
/**
* Set the name for the Endpoint, replacing any name already set.
* @param name the endpoint name
* @return the Endpoint.Builder
*/
public Builder name(String name) {
this.name = name;
return this;
}
/**
* Set the queueGroup for the Endpoint, overriding the system default queue group
* @param queueGroup the queueGroup
* @return the Endpoint.Builder
*/
public Builder queueGroup(String queueGroup) {
this.queueGroup = queueGroup == null ? DEFAULT_QGROUP : queueGroup;
return this;
}
/**
* Set the subject for the Endpoint, replacing any subject already set.
* @param subject the subject
* @return the Endpoint.Builder
*/
public Builder subject(String subject) {
this.subject = subject;
return this;
}
/**
* Set the metadata for the Endpoint, replacing any metadata already set.
* @param metadata the metadata
* @return the Endpoint.Builder
*/
public Builder metadata(Map metadata) {
if (metadata == null || metadata.isEmpty()) {
this.metadata = null;
}
else {
this.metadata = new HashMap<>(metadata);
}
return this;
}
/**
* Build the Endpoint instance.
* @return the Endpoint instance
*/
public Endpoint build() {
return new Endpoint(this);
}
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
Endpoint endpoint = (Endpoint) o;
if (!Objects.equals(name, endpoint.name)) return false;
if (!Objects.equals(subject, endpoint.subject)) return false;
if (!Objects.equals(queueGroup, endpoint.queueGroup)) return false;
return Objects.equals(metadata, endpoint.metadata);
}
@Override
public int hashCode() {
int result = name != null ? name.hashCode() : 0;
result = 31 * result + (subject != null ? subject.hashCode() : 0);
result = 31 * result + (queueGroup != null ? queueGroup.hashCode() : 0);
result = 31 * result + (metadata != null ? metadata.hashCode() : 0);
return result;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy