org.glassfish.grizzly.config.ssl.ServerSocketFactory Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2004 The Apache Software Foundation
*
* 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.glassfish.grizzly.config.ssl;
import java.io.IOException;
import java.net.InetAddress;
import java.net.ServerSocket;
import java.net.Socket;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.Map;
import javax.net.ssl.SSLContext;
/**
* This class creates server sockets. It may be subclassed by other factories, which create particular types of server
* sockets. This provides a general framework for the addition of public socket-level functionality. It it is the
* server side analogue of a socket factory, and similarly provides a way to capture a variety of policies related to
* the sockets being constructed.
*
* Like socket factories, Server Socket factory instances have two categories of methods. First are methods used to
* create sockets. Second are methods which set properties used in the production of sockets, such as networking
* options. There is also an environment specific default server socket factory; frameworks will often use their own
* customized factory.
*
*
It may be desirable to move this interface into the java.net package, so that is not an extension
* but the preferred interface. Should this be serializable, making it a JavaBean which can be saved along with its
* networking configuration?
*
* @author [email protected]
* @author Harish Prabandham
*/
public abstract class ServerSocketFactory implements Cloneable {
private static ServerSocketFactory theFactory;
protected SSLContext context;
protected final Map attributes = new HashMap();
/**
* Constructor is used only by subclasses.
*/
protected ServerSocketFactory() {
}
/**
* Returns a server socket which uses all network interfaces on the host, and is bound to a the specified port. The
* socket is configured with the socket options (such as accept timeout) given to this factory.
*
* @param port the port to listen to
*
* @throws IOException for networking errors
* @throws InstantiationException for construction errors
*/
public abstract ServerSocket createSocket(int port) throws IOException, InstantiationException;
/**
* Returns a server socket which uses all network interfaces on the host, is bound to a the specified port, and uses
* the specified connection backlog. The socket is configured with the socket options (such as accept timeout)
* given to this factory.
*
* @param port the port to listen to
* @param backlog how many connections are queued
*
* @throws IOException for networking errors
* @throws InstantiationException for construction errors
*/
public abstract ServerSocket createSocket(int port, int backlog) throws IOException, InstantiationException;
/**
* Returns a server socket which uses only the specified network interface on the local host, is bound to a the
* specified port, and uses the specified connection backlog. The socket is configured with the socket options
* (such as accept timeout) given to this factory.
*
* @param port the port to listen to
* @param backlog how many connections are queued
* @param ifAddress the network interface address to use
*
* @throws IOException for networking errors
* @throws InstantiationException for construction errors
*/
public abstract ServerSocket createSocket(int port, int backlog, InetAddress ifAddress)
throws IOException, InstantiationException;
/**
* Wrapper function for accept(). This allows us to trap and translate exceptions if necessary
*
* @throws IOException;
*/
public abstract Socket acceptSocket(ServerSocket socket) throws IOException;
/**
* Extra function to initiate the handshake. Sometimes necessary for SSL
*
* @throws IOException;
*/
public abstract void handshake(Socket sock) throws IOException;
public abstract void init() throws IOException;
public void initSocket(Socket s) {
}
/**
* Return the {@link SSLContext} required when implementing SSL over NIO non-blocking.
*
* @return SSLContext
*/
public SSLContext getSSLContext() {
return context;
}
/**
* General mechanism to pass attributes from the ServerConnector to the socket factory.
*
* Note that the "preferred" mechanism is to use bean setters and explicit methods, but this allows easy
* configuration via server.xml or simple Properties
*/
public void setAttribute(String name, Object value) {
if (name != null && value != null) {
attributes.put(name, value);
}
}
/**
* Returns a copy of the environment's default socket factory.
*/
public static synchronized ServerSocketFactory getDefault() {
if (theFactory == null) {
theFactory = new DefaultServerSocketFactory();
}
try {
return (ServerSocketFactory) theFactory.clone();
} catch (CloneNotSupportedException e) {
throw new RuntimeException(e.getMessage());
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy