org.wildfly.security.auth.callback.SocketAddressCallback Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source.
* Copyright 2014 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* 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.wildfly.security.auth.callback;
import org.wildfly.common.Assert;
import java.io.Serializable;
import java.net.SocketAddress;
/**
* An optional callback which is used to inform the callback handler of the endpoint addresses of a connection being
* authenticated.
*
* @author David M. Lloyd
*/
public final class SocketAddressCallback implements ExtendedCallback, Serializable {
private static final long serialVersionUID = -4287450716990929230L;
/**
* @serial The socket address.
*/
private final SocketAddress address;
/**
* @serial The socket address disposition or "kind".
*/
private final Kind kind;
/**
* Construct a new instance.
*
* @param address the endpoint socket address
* @param kind the disposition of the endpoint
*/
public SocketAddressCallback(final SocketAddress address, final Kind kind) {
this.address = Assert.checkNotNullParam("address", address);
this.kind = Assert.checkNotNullParam("kind", kind);
}
/**
* Construct a new instance. The disposition is assumed to be {@link Kind#PEER}.
*
* @param address the endpoint socket address
*/
public SocketAddressCallback(final SocketAddress address) {
this(address, Kind.PEER);
}
/**
* Get the endpoint socket address.
*
* @return the endpoint socket address
*/
public SocketAddress getAddress() {
return address;
}
/**
* Get the endpoint disposition.
*
* @return the endpoint disposition
*/
public Kind getKind() {
return kind;
}
/**
* Endpoint disposition kinds.
*/
public enum Kind {
/**
* The local endpoint.
*/
LOCAL,
/**
* The remote (peer) endpoint.
*/
PEER,
;
}
}