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

Platform Symphony 5.1 Java API Reference

com.platform.symphony.soam
Class DefaultSecurityCallback

java.lang.Object
  extended by com.platform.symphony.soam.ConnectionSecurityCallback
      extended by com.platform.symphony.soam.DefaultSecurityCallback

public class DefaultSecurityCallback
extends ConnectionSecurityCallback

This implementation of ConnectionSecurityCallback uses the middleware's built-in security framework for client verification. To use custom security framework, implement the ConnectionSecurityCallback interface.

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:
ConnectionSecurityCallback, SoamFactory.connect(String, ConnectionSecurityCallback), SoamFactory.connect(String, String, ConnectionSecurityCallback)

Constructor Summary
DefaultSecurityCallback(java.lang.String username, java.lang.String password)
          Constructor for the callback object.
 
Method Summary
 java.lang.String onGetAuthname()
          Retrieves and returns the authorization domain that is used to validate the client to the middleware.
 java.lang.String onGetPassword()
          Retrieves and returns the password that is used to validate the client to the middleware.
 java.lang.String onGetTtl()
          Retrieves and returns the time to live that is used to validate the client to the middleware.
 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

DefaultSecurityCallback

public DefaultSecurityCallback(java.lang.String username,
                               java.lang.String password)
Constructor for the callback object.

Parameters:
username - The name of the user A null value will be treated as an empty string.
password - The password to be used in combination with the given username for authentication. A null value will be treated as an empty string.
Method Detail

onGetUsername

public 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.

Specified by:
onGetUsername in class ConnectionSecurityCallback
Returns:
The username.

onGetPassword

public 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.

Specified by:
onGetPassword in class ConnectionSecurityCallback
Returns:
The password.

onGetAuthname

public 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.

Specified by:
onGetAuthname in class ConnectionSecurityCallback
Returns:
The authorization domain.

onGetTtl

public 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.

Specified by:
onGetTtl in class ConnectionSecurityCallback
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.