org.jivesoftware.smackx.hoxt.packet.HttpOverXmppResp Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smack-experimental Show documentation

Smack experimental extensions. Classes and methods for XEPs that are in status 'experimental' or that should otherwise carefully considered for deployment. The API may change even between patch versions.

There is a newer version: 4.5.0-beta5

Show newest version

/**
 *
 * Copyright 2014 Andriy Tsykholyas
 *
 * 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.jivesoftware.smackx.hoxt.packet;

import org.jivesoftware.smack.util.Objects;

/**
 * Represents Resp IQ packet.
 *
 * @author Andriy Tsykholyas
 * @see XEP-0332: HTTP over XMPP transport
 */
public final class HttpOverXmppResp extends AbstractHttpOverXmpp {

    public static final String ELEMENT = "resp";

    private HttpOverXmppResp(Builder builder) {
        super(ELEMENT, builder);
        this.statusCode = Objects.requireNonNull(builder.statusCode, "statusCode must not be null");
        this.statusMessage = builder.statusMessage;
    }

    private final int statusCode;
    private final String statusMessage;

    @Override
    protected IQChildElementXmlStringBuilder getIQHoxtChildElementBuilder(IQChildElementXmlStringBuilder builder) {
        builder.attribute("version", getVersion());
        builder.attribute("statusCode", statusCode);
        builder.optAttribute("statusMessage", statusMessage);
        builder.rightAngleBracket();
        return builder;
    }

    /**
     * Returns statusCode attribute.
     *
     * @return statusCode attribute
     */
    public int getStatusCode() {
        return statusCode;
    }

    /**
     * Returns statusMessage attribute.
     *
     * @return statusMessage attribute
     */
    public String getStatusMessage() {
        return statusMessage;
    }

    public static Builder builder() {
        return new Builder();
    }

    /**
     * A configuration builder for HttpOverXmppReq. Use {@link HttpOverXmppResp#builder()} to obtain a new instance and
     * {@link #build} to build the configuration.
     */
    public static final class Builder extends AbstractHttpOverXmpp.Builder {

        private int statusCode = 200;
        private String statusMessage = null;

        private Builder() {
        }

        /**
         * Sets statusCode attribute.
         *
         * @param statusCode statusCode attribute
         *
         * @return the builder
         */
        public Builder setStatusCode(int statusCode) {
            this.statusCode = statusCode;
            return this;
        }

        /**
         * Sets statusMessage attribute.
         *
         * @param statusMessage statusMessage attribute
         *
         * @return the builder
         */
        public Builder setStatusMessage(String statusMessage) {
            this.statusMessage = statusMessage;
            return this;

        }

        @Override
        public HttpOverXmppResp build() {
            return new HttpOverXmppResp(this);
        }

        @Override
        protected Builder getThis() {
            return this;
        }
    }

}