Visit Platform at http://www.platform.com

Platform Symphony 5.1 Java API Reference

com.platform.symphony.soam
Class ConnectionSecurityCallback

java.lang.Object
  extended by com.platform.symphony.soam.ConnectionSecurityCallback
Direct Known Subclasses:
DefaultSecurityCallback

public abstract class ConnectionSecurityCallback
extends java.lang.Object

Should be extended by the application developer to allow client verification using custom security framework.

Alternatively, the SOAM API provides a default implementation (DefaultSecurityCallback), which uses the middleware's built-in security framework for client verification.

NOTE: If any of the methods of this class are called after the Main(...) method exits, the client or service process may behave in an undefined manner (for example, hang or terminate abnormally).

See Also:
DefaultSecurityCallback, SoamFactory.connect(String, ConnectionSecurityCallback), SoamFactory.connect(String, String, ConnectionSecurityCallback)

Constructor Summary
ConnectionSecurityCallback()
          Default Constructor
 
Method Summary
abstract  java.lang.String onGetAuthname()
          Retrieves and returns the authorization domain that is used to validate the client to the middleware.
abstract  java.lang.String onGetPassword()
          Retrieves and returns the password that is used to validate the client to the middleware.
abstract  java.lang.String onGetTtl()
          Retrieves and returns the time to live that is used to validate the client to the middleware.
abstract  java.lang.String onGetUsername()
          Retrieves and returns the username that is used to validate the client to the middleware.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConnectionSecurityCallback

public ConnectionSecurityCallback()
Default Constructor

Method Detail

onGetUsername

public abstract java.lang.String onGetUsername()
Retrieves and returns the username that is used to validate the client to the middleware. Invoked when user authentication is required while establishing a connection.
This method is to be implemented by the application developer.

Returns:
The username.

onGetPassword

public abstract java.lang.String onGetPassword()
Retrieves and returns the password that is used to validate the client to the middleware. Invoked when a password is required while establishing a connection.
This method is to be implemented by the application developer.

Returns:
The password.

onGetAuthname

public abstract java.lang.String onGetAuthname()
Retrieves and returns the authorization domain that is used to validate the client to the middleware. Invoked when an authorization domain is required while establishing a connection.
This method is to be implemented by the application developer.

Returns:
The authorization domain.

onGetTtl

public abstract java.lang.String onGetTtl()
Retrieves and returns the time to live that is used to validate the client to the middleware. Invoked when a time to live value is required while establishing a connection.
This method is to be implemented by the application developer.

Returns:
The time to live.

Version 5.1
Date Modified: -DREL_DATE=Apr 28 2011
Platform Computing. Accelerating Intelligence(TM).
Copyright (C) 2001-2009 Platform Computing Corporation. All rights reserved.