io.r2dbc.postgresql.message.backend.NotificationResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of r2dbc-postgresql Show documentation
Reactive Relational Database Connectivity Driver Implementation for Postgresql
There is a newer version: 0.8.13.RELEASE
/*
 * Copyright 2017-2020 the original author or 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
 *
 *      https://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.r2dbc.postgresql.message.backend;

import io.netty.buffer.ByteBuf;
import io.r2dbc.postgresql.util.Assert;

import java.util.Objects;

import static io.r2dbc.postgresql.message.backend.BackendMessageUtils.readCStringUTF8;

/**
 * The NotificationResponse message.
 */
public final class NotificationResponse implements BackendMessage {

    private final String name;

    private final String payload;

    private final int processId;

    /**
     * Create a new message.
     *
     * @param name      the name of the channel that the notify has been raised on
     * @param payload   the “payload” string passed from the notifying process
     * @param processId the process ID of the notifying backend process
     * @throws IllegalArgumentException if {@code name} or {@code payload} is {@code null}
     */
    public NotificationResponse(String name, String payload, int processId) {
        this.name = Assert.requireNonNull(name, "name must not be null");
        this.payload = Assert.requireNonNull(payload, "payload must not be null");
        this.processId = processId;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        NotificationResponse that = (NotificationResponse) o;
        return this.processId == that.processId &&
            Objects.equals(this.name, that.name) &&
            Objects.equals(this.payload, that.payload);
    }

    /**
     * Returns the name of the channel that the notify has been raised on.
     *
     * @return the name of the channel that the notify has been raised on
     */
    public String getName() {
        return this.name;
    }

    /**
     * Returns the “payload” string passed from the notifying process.
     *
     * @return the “payload” string passed from the notifying process
     */
    public String getPayload() {
        return this.payload;
    }

    /**
     * Returns the process ID of the notifying backend process.
     *
     * @return the process ID of the notifying backend process
     */
    public int getProcessId() {
        return this.processId;
    }

    @Override
    public int hashCode() {
        return Objects.hash(this.name, this.payload, this.processId);
    }

    @Override
    public String toString() {
        return "NotificationResponse{" +
            "name='" + this.name + '\'' +
            ", payload='" + this.payload + '\'' +
            ", processId=" + this.processId +
            '}';
    }

    static NotificationResponse decode(ByteBuf in) {
        Assert.requireNonNull(in, "in must not be null");

        int processId = in.readInt();
        String name = readCStringUTF8(in);
        String payload = readCStringUTF8(in);

        return new NotificationResponse(name, payload, processId);
    }

}