Package org.eblocker.server.common.openvpn

Class OpenVpnService

java.lang.Object

org.eblocker.server.common.openvpn.OpenVpnService

public class OpenVpnService
extends Object

This class makes all the work which is asked for by the OpenVpnController (REST Interface). It will trigger/tell the other objects to adapt the firewall configuration, rewrite squids config and so on...

Constructor Summary

Constructors

Constructor	Description
OpenVpnService(ScriptRunner scriptRunner, DataSource dataSource, OpenVpnClientFactory openVpnClientFactory, OpenVpnConfigurator configurator, OpenVpnFileOptionValidator fileOptionValidator, String keepAliveTarget, String killAllInstancesScript, OpenVpnProfileFiles profileFiles, String passwordMask, Integer stoppedClientTimeout)

Method Summary

Modifier and Type	Method	Description
void	deleteVpnProfile(int id)
Runnable	getCacheCleaner()
OpenVpnProfile	getOpenVpnProfileById(int id)	Get a OpenVpn profile for a given ID
OpenVpnConfiguration	getProfileClientConfig(int id)
VpnStatus	getStatus(VpnProfile profile)
VpnStatus	getStatusByDevice(Device device)
VpnProfile	getVpnProfileById(int id)	Get a VPN profile for a given ID
Collection<VpnProfile>	getVpnProfiles()	Get all VPN profiles
void	init()
void	restoreNormalRoutingForClient(Device device)	Do not route device through VpnProfile (and the VPN tunnel which belongs to this profile) anymore When this was the last device using this VPN profile, it will automatically get shutdown/stopped
void	routeClientThroughVpnTunnel(Device device, VpnProfile vpnProfile)
OpenVpnProfile	saveProfile(OpenVpnProfile profile)
OpenVpnConfiguration	setProfileClientConfig(int id, String config)
OpenVpnConfiguration	setProfileClientConfigOptionFile(int id, String option, byte[] content)
void	shutdown()
void	startVpn(VpnProfile profile)
void	stopVpn(VpnProfile profile)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenVpnService

@Inject
public OpenVpnService(ScriptRunner scriptRunner,
 DataSource dataSource,
 OpenVpnClientFactory openVpnClientFactory,
 OpenVpnConfigurator configurator,
 OpenVpnFileOptionValidator fileOptionValidator,
 String keepAliveTarget,
 String killAllInstancesScript,
 OpenVpnProfileFiles profileFiles,
 String passwordMask,
 Integer stoppedClientTimeout)

Method Details

init

public void init()

getVpnProfiles

public Collection<VpnProfile> getVpnProfiles()

Get all VPN profiles

Returns:

Collection of VpnProfile objects with masked passwords.

saveProfile

public OpenVpnProfile saveProfile(OpenVpnProfile profile)
                           throws IOException

Throws:

IOException

deleteVpnProfile

public void deleteVpnProfile(int id)

getProfileClientConfig

public OpenVpnConfiguration getProfileClientConfig(int id)
                                            throws IOException

Throws:

IOException

setProfileClientConfig

public OpenVpnConfiguration setProfileClientConfig(int id,
 String config)
                                            throws IOException

Throws:

IOException

setProfileClientConfigOptionFile

public OpenVpnConfiguration setProfileClientConfigOptionFile(int id,
 String option,
 byte[] content)
                                                      throws IOException

Throws:

IOException

getVpnProfileById

public VpnProfile getVpnProfileById(int id)

Get a VPN profile for a given ID

Parameters:

id -

Returns:

VpnProfile with masked password

getOpenVpnProfileById

public OpenVpnProfile getOpenVpnProfileById(int id)

Get a OpenVpn profile for a given ID

Parameters:

id -

Returns:

OpenVpnProfile with clear-text password

routeClientThroughVpnTunnel

public void routeClientThroughVpnTunnel(Device device,
 VpnProfile vpnProfile)

restoreNormalRoutingForClient

public void restoreNormalRoutingForClient(Device device)

Do not route device through VpnProfile (and the VPN tunnel which belongs to this profile) anymore When this was the last device using this VPN profile, it will automatically get shutdown/stopped

Parameters:

device -

startVpn

public void startVpn(VpnProfile profile)

stopVpn

public void stopVpn(VpnProfile profile)

getStatus

public VpnStatus getStatus(VpnProfile profile)

getStatusByDevice

public VpnStatus getStatusByDevice(Device device)

getCacheCleaner

public Runnable getCacheCleaner()

shutdown

public void shutdown()