Package org.epics.pvaccess.plugins.impl.client

Class CAClientSecurityPlugin

java.lang.Object

org.epics.pvaccess.plugins.impl.client.CAClientSecurityPlugin

All Implemented Interfaces:

SecurityPlugin, SecurityPlugin.ChannelSecuritySession, SecurityPlugin.SecuritySession

public class CAClientSecurityPlugin
extends Object
implements SecurityPlugin, SecurityPlugin.SecuritySession, SecurityPlugin.ChannelSecuritySession

Nested Class Summary

Nested classes/interfaces inherited from interface org.epics.pvaccess.plugins.SecurityPlugin

SecurityPlugin.ChannelSecuritySession, SecurityPlugin.SecurityPluginControl, SecurityPlugin.SecuritySession

Field Summary

Fields inherited from interface org.epics.pvaccess.plugins.SecurityPlugin

SECURITY_PLUGINS_CLIENT_KEY, SECURITY_PLUGINS_SERVER_KEY

Constructor Summary

Constructors

Constructor	Description
CAClientSecurityPlugin()

Method Summary

Modifier and Type	Method	Description
org.epics.pvdata.pv.Status	authorizeCreateChannelArray(int ioid, org.epics.pvdata.pv.PVStructure pvRequest)
org.epics.pvdata.pv.Status	authorizeCreateChannelGet(int ioid, org.epics.pvdata.pv.PVStructure pvRequest)
org.epics.pvdata.pv.Status	authorizeCreateChannelProcess(int ioid, org.epics.pvdata.pv.PVStructure pvRequest)
org.epics.pvdata.pv.Status	authorizeCreateChannelPut(int ioid, org.epics.pvdata.pv.PVStructure pvRequest)
org.epics.pvdata.pv.Status	authorizeCreateChannelPutGet(int ioid, org.epics.pvdata.pv.PVStructure pvRequest)
org.epics.pvdata.pv.Status	authorizeCreateChannelRPC(int ioid, org.epics.pvdata.pv.PVStructure pvRequest)
org.epics.pvdata.pv.Status	authorizeCreateMonitor(int ioid, org.epics.pvdata.pv.PVStructure pvRequest)
org.epics.pvdata.pv.Status	authorizeGet(int ioid)
org.epics.pvdata.pv.Status	authorizeGetField(int ioid, String subField)
org.epics.pvdata.pv.Status	authorizeMonitor(int ioid)
org.epics.pvdata.pv.Status	authorizeProcess(int ioid)
org.epics.pvdata.pv.Status	authorizePut(int ioid, org.epics.pvdata.pv.PVArray dataToPut)
org.epics.pvdata.pv.Status	authorizePut(int ioid, org.epics.pvdata.pv.PVStructure dataToPut, org.epics.pvdata.misc.BitSet fieldsToPut)
org.epics.pvdata.pv.Status	authorizePutGet(int ioid, org.epics.pvdata.pv.PVStructure dataToPut, org.epics.pvdata.misc.BitSet fieldsToPut)
org.epics.pvdata.pv.Status	authorizeRPC(int ioid, org.epics.pvdata.pv.PVStructure arguments)
org.epics.pvdata.pv.Status	authorizeSetLength(int ioid)
void	close()
SecurityPlugin.ChannelSecuritySession	createChannelSession(String channelName)
SecurityPlugin.SecuritySession	createSession(InetSocketAddress remoteAddress, SecurityPlugin.SecurityPluginControl control, org.epics.pvdata.pv.PVField data)
String	getDescription()	Description of the security plug-in.
String	getId()	Short, unique name for the plug-in, used to identify the plugin.
SecurityPlugin	getSecurityPlugin()
org.epics.pvdata.pv.PVField	initializationData()
boolean	isValidFor(InetSocketAddress remoteAddress)	Check whether the remote instance with given network address is valid to use this security plug-in to authNZ.
void	messageReceived(org.epics.pvdata.pv.PVField data)
void	release(int ioid)

Methods inherited from class java.lang.Object

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

Constructor Detail

CAClientSecurityPlugin

public CAClientSecurityPlugin()

Method Detail

getId

public String getId()

Description copied from interface: SecurityPlugin

Short, unique name for the plug-in, used to identify the plugin.

Specified by:

getId in interface SecurityPlugin

Returns:

the ID.

getDescription

public String getDescription()

Description copied from interface: SecurityPlugin

Description of the security plug-in.

Specified by:

getDescription in interface SecurityPlugin

Returns:

the description string.

isValidFor

public boolean isValidFor(InetSocketAddress remoteAddress)

Description copied from interface: SecurityPlugin

Check whether the remote instance with given network address is valid to use this security plug-in to authNZ.

Specified by:

isValidFor in interface SecurityPlugin

Parameters:

remoteAddress - address to validate.

Returns:

true if this security plugin can be used for remote instance.

initializationData

public org.epics.pvdata.pv.PVField initializationData()

Specified by:

initializationData in interface SecurityPlugin.SecuritySession

createSession

public SecurityPlugin.SecuritySession createSession(InetSocketAddress remoteAddress,
                                                    SecurityPlugin.SecurityPluginControl control,
                                                    org.epics.pvdata.pv.PVField data)
                                             throws SecurityException

Specified by:

createSession in interface SecurityPlugin

Throws:

SecurityException

getSecurityPlugin

public SecurityPlugin getSecurityPlugin()

Specified by:

getSecurityPlugin in interface SecurityPlugin.SecuritySession

messageReceived

public void messageReceived(org.epics.pvdata.pv.PVField data)

Specified by:

messageReceived in interface SecurityPlugin.SecuritySession

close

public void close()

Specified by:

close in interface SecurityPlugin.ChannelSecuritySession

Specified by:

close in interface SecurityPlugin.SecuritySession

createChannelSession

public SecurityPlugin.ChannelSecuritySession createChannelSession(String channelName)
                                                           throws SecurityException

Specified by:

createChannelSession in interface SecurityPlugin.SecuritySession

Throws:

SecurityException

authorizeCreateChannelProcess

public org.epics.pvdata.pv.Status authorizeCreateChannelProcess(int ioid,
                                                                org.epics.pvdata.pv.PVStructure pvRequest)

Specified by:

authorizeCreateChannelProcess in interface SecurityPlugin.ChannelSecuritySession

authorizeProcess

public org.epics.pvdata.pv.Status authorizeProcess(int ioid)

Specified by:

authorizeProcess in interface SecurityPlugin.ChannelSecuritySession

authorizeCreateChannelGet

public org.epics.pvdata.pv.Status authorizeCreateChannelGet(int ioid,
                                                            org.epics.pvdata.pv.PVStructure pvRequest)

Specified by:

authorizeCreateChannelGet in interface SecurityPlugin.ChannelSecuritySession

authorizeGet

public org.epics.pvdata.pv.Status authorizeGet(int ioid)

Specified by:

authorizeGet in interface SecurityPlugin.ChannelSecuritySession

authorizeCreateChannelPut

public org.epics.pvdata.pv.Status authorizeCreateChannelPut(int ioid,
                                                            org.epics.pvdata.pv.PVStructure pvRequest)

Specified by:

authorizeCreateChannelPut in interface SecurityPlugin.ChannelSecuritySession

authorizePut

public org.epics.pvdata.pv.Status authorizePut(int ioid,
                                               org.epics.pvdata.pv.PVStructure dataToPut,
                                               org.epics.pvdata.misc.BitSet fieldsToPut)

Specified by:

authorizePut in interface SecurityPlugin.ChannelSecuritySession

authorizeCreateChannelPutGet

public org.epics.pvdata.pv.Status authorizeCreateChannelPutGet(int ioid,
                                                               org.epics.pvdata.pv.PVStructure pvRequest)

Specified by:

authorizeCreateChannelPutGet in interface SecurityPlugin.ChannelSecuritySession

authorizePutGet

public org.epics.pvdata.pv.Status authorizePutGet(int ioid,
                                                  org.epics.pvdata.pv.PVStructure dataToPut,
                                                  org.epics.pvdata.misc.BitSet fieldsToPut)

Specified by:

authorizePutGet in interface SecurityPlugin.ChannelSecuritySession

authorizeCreateChannelRPC

public org.epics.pvdata.pv.Status authorizeCreateChannelRPC(int ioid,
                                                            org.epics.pvdata.pv.PVStructure pvRequest)

Specified by:

authorizeCreateChannelRPC in interface SecurityPlugin.ChannelSecuritySession

authorizeRPC

public org.epics.pvdata.pv.Status authorizeRPC(int ioid,
                                               org.epics.pvdata.pv.PVStructure arguments)

Specified by:

authorizeRPC in interface SecurityPlugin.ChannelSecuritySession

authorizeCreateMonitor

public org.epics.pvdata.pv.Status authorizeCreateMonitor(int ioid,
                                                         org.epics.pvdata.pv.PVStructure pvRequest)

Specified by:

authorizeCreateMonitor in interface SecurityPlugin.ChannelSecuritySession

authorizeMonitor

public org.epics.pvdata.pv.Status authorizeMonitor(int ioid)

Specified by:

authorizeMonitor in interface SecurityPlugin.ChannelSecuritySession

authorizeCreateChannelArray

public org.epics.pvdata.pv.Status authorizeCreateChannelArray(int ioid,
                                                              org.epics.pvdata.pv.PVStructure pvRequest)

Specified by:

authorizeCreateChannelArray in interface SecurityPlugin.ChannelSecuritySession

authorizeSetLength

public org.epics.pvdata.pv.Status authorizeSetLength(int ioid)

Specified by:

authorizeSetLength in interface SecurityPlugin.ChannelSecuritySession

authorizePut

public org.epics.pvdata.pv.Status authorizePut(int ioid,
                                               org.epics.pvdata.pv.PVArray dataToPut)

Specified by:

authorizePut in interface SecurityPlugin.ChannelSecuritySession

authorizeGetField

public org.epics.pvdata.pv.Status authorizeGetField(int ioid,
                                                    String subField)

Specified by:

authorizeGetField in interface SecurityPlugin.ChannelSecuritySession

release

public void release(int ioid)

Specified by:

release in interface SecurityPlugin.ChannelSecuritySession