com.liferay.portal.kernel.cluster.ClusterRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of com.liferay.portal.kernel Show documentation

Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.

There is a newer version: 156.0.0

Show newest version

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.portal.kernel.cluster;

import com.liferay.portal.kernel.security.SecureRandomUtil;
import com.liferay.portal.kernel.util.StringBundler;

import java.io.Serializable;

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import java.util.UUID;

/**
 * @author Tina Tian
 */
public class ClusterRequest implements Serializable {

	public static ClusterRequest createMulticastRequest(Serializable payload) {
		return createMulticastRequest(payload, false);
	}

	public static ClusterRequest createMulticastRequest(
		Serializable payload, boolean skipLocal) {

		return new ClusterRequest(payload, skipLocal, true);
	}

	public static ClusterRequest createUnicastRequest(
		Serializable payload, String... targetClusterNodeIds) {

		if ((targetClusterNodeIds == null) ||
			(targetClusterNodeIds.length == 0)) {

			throw new NullPointerException("Target cluster node IDs is null");
		}

		return new ClusterRequest(payload, false, false, targetClusterNodeIds);
	}

	public Serializable getPayload() {
		return _payload;
	}

	public Set getTargetClusterNodeIds() {
		return Collections.unmodifiableSet(_targetClusterNodeIds);
	}

	public String getUuid() {
		return _uuid;
	}

	public boolean isFireAndForget() {
		return _fireAndForget;
	}

	public boolean isMulticast() {
		return _multicast;
	}

	public boolean isSkipLocal() {
		return _skipLocal;
	}

	public void setFireAndForget(boolean fireAndForget) {
		_fireAndForget = fireAndForget;
	}

	@Override
	public String toString() {
		StringBundler sb = new StringBundler(11);

		sb.append("{multicast=");
		sb.append(_multicast);
		sb.append(", payload=");
		sb.append(_payload);
		sb.append(", skipLocal=");
		sb.append(_skipLocal);

		if (!_multicast) {
			sb.append(", _targetClusterNodeIds=");
			sb.append(_targetClusterNodeIds);
		}

		sb.append(", uuid=");
		sb.append(_uuid);
		sb.append("}");

		return sb.toString();
	}

	private ClusterRequest(
		Serializable payload, boolean skipLocal, boolean multicast,
		String... targetClusterNodeIds) {

		if (payload == null) {
			throw new NullPointerException("Payload is null");
		}

		_payload = payload;
		_skipLocal = skipLocal;
		_multicast = multicast;

		_uuid = _generateUUID();

		for (String targetClusterNodeId : targetClusterNodeIds) {
			_targetClusterNodeIds.add(targetClusterNodeId);
		}
	}

	private String _generateUUID() {
		UUID uuid = new UUID(
			SecureRandomUtil.nextLong(), SecureRandomUtil.nextLong());

		return uuid.toString();
	}

	private boolean _fireAndForget;
	private final boolean _multicast;
	private final Serializable _payload;
	private final boolean _skipLocal;
	private final Set _targetClusterNodeIds = new HashSet<>();
	private final String _uuid;

}