/**
* Copyright 2005-2011 Noelios Technologies.
*
* The contents of this file are subject to the terms of one of the following
* open source licenses: LGPL 3.0 or LGPL 2.1 or CDDL 1.0 or EPL 1.0 (the
* "Licenses"). You can select the license that you prefer but you may not use
* this file except in compliance with one of these Licenses.
*
* You can obtain a copy of the LGPL 3.0 license at
* http://www.opensource.org/licenses/lgpl-3.0.html
*
* You can obtain a copy of the LGPL 2.1 license at
* http://www.opensource.org/licenses/lgpl-2.1.php
*
* You can obtain a copy of the CDDL 1.0 license at
* http://www.opensource.org/licenses/cddl1.php
*
* You can obtain a copy of the EPL 1.0 license at
* http://www.opensource.org/licenses/eclipse-1.0.php
*
* See the Licenses for the specific language governing permissions and
* limitations under the Licenses.
*
* Alternatively, you can obtain a royalty free commercial license with less
* limitations, transferable or non-transferable, directly at
* http://www.noelios.com/products/restlet-engine
*
* Restlet is a registered trademark of Noelios Technologies.
*/
package org.restlet.ext.ssl;
import java.io.IOException;
import java.net.InetSocketAddress;
import java.nio.channels.SocketChannel;
import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLEngine;
import org.restlet.Client;
import org.restlet.data.Protocol;
import org.restlet.engine.connector.ClientConnectionHelper;
import org.restlet.engine.connector.Connection;
import org.restlet.engine.connector.ConnectionController;
import org.restlet.engine.connector.InboundWay;
import org.restlet.engine.connector.OutboundWay;
import org.restlet.ext.ssl.internal.HttpsClientInboundWay;
import org.restlet.ext.ssl.internal.HttpsClientOutboundWay;
import org.restlet.ext.ssl.internal.SslConnection;
import org.restlet.ext.ssl.internal.SslUtils;
/**
* HTTPS client helper based on NIO blocking sockets. Here is the list of SSL
* related parameters that are also supported:
* <table>
* <tr>
* <th>Parameter name</th>
* <th>Value type</th>
* <th>Default value</th>
* <th>Description</th>
* </tr>
* <tr>
* <td>sslContextFactory</td>
* <td>String</td>
* <td>org.restlet.ext.ssl.DefaultSslContextFactory</td>
* <td>Let you specify a {@link SslContextFactory} qualified class name as a
* parameter, or an instance as an attribute for a more complete and flexible
* SSL context setting.</td>
* </tr>
* </table>
* For the default SSL parameters see the Javadocs of the
* {@link DefaultSslContextFactory} class.
*
* @author Jerome Louvel
*/
public class HttpsClientHelper extends ClientConnectionHelper {
/** The SSL context. */
private volatile SSLContext sslContext;
/**
* Constructor.
*
* @param client
* The client to help.
*/
public HttpsClientHelper(Client client) {
super(client);
getProtocols().add(Protocol.HTTPS);
}
@Override
protected Connection<Client> createConnection(SocketChannel socketChannel,
ConnectionController controller, InetSocketAddress socketAddress)
throws IOException {
// Create the SSL engine
SSLEngine engine;
if (socketAddress != null) {
engine = getSslContext().createSSLEngine(
socketAddress.getHostName(), socketAddress.getPort());
} else {
engine = getSslContext().createSSLEngine();
}
return new SslConnection<Client>(this, socketChannel, controller,
socketAddress, engine);
}
@Override
public InboundWay createInboundWay(Connection<Client> connection,
int bufferSize) {
return new HttpsClientInboundWay(connection, bufferSize);
}
@Override
public OutboundWay createOutboundWay(Connection<Client> connection,
int bufferSize) {
return new HttpsClientOutboundWay(connection, bufferSize);
}
/**
* Returns the SSL context.
*
* @return The SSL context.
*/
protected SSLContext getSslContext() {
return sslContext;
}
/**
* Sets the SSL context.
*
* @param sslContext
* The SSL context.
*/
protected void setSslContext(SSLContext sslContext) {
this.sslContext = sslContext;
}
@Override
public synchronized void start() throws Exception {
SslContextFactory factory = SslUtils.getSslContextFactory(this);
setSslContext(factory.createSslContext());
super.start();
}
}