|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.websphere.security.WebSphereBaseTrustAssociationInterceptor
Abstract base class for TrustAssociationInterceptor
Constructor Summary | |
---|---|
WebSphereBaseTrustAssociationInterceptor()
|
Method Summary | |
---|---|
abstract void |
cleanup()
clean up the TrustAssociation |
java.lang.String |
getType()
Get type |
java.lang.String |
getVersion()
Get version number. |
int |
init(java.util.Properties props)
Initializes the Trust Association Interceptor implementation. |
int |
init(java.lang.String propsfile)
If the above init(Properties) method has been implemented by the TAI implementation, this method is not required to be implemented. |
void |
setType(java.lang.String t)
Set type |
void |
setVersion(java.lang.String s)
Set version number. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public WebSphereBaseTrustAssociationInterceptor()
Method Detail |
public int init(java.util.Properties props)
props
- the properties with which to initialize the
Custom Trust Association Interceptor.This method is called to initialize the Trust Association Interceptor. This needs to be implemented by all the TAI implementations when properties are defined in Trust Association properties.
The default implementation of this method calls the init(String) method with the file name containing the properties file to make this compatible with older versions of Trust Association implementations. If the file name cannot be obtained, a -1 is returned to indicate error. However, it is highly recommended that one implement this method to initialize their Custom Trust Association implementations instead of relying on the default implementation (in which case the init(String) method needs to be implemented).
Also, note that unlike in the previous versions the return status is now checked before using the Trust Association implementation. A return of 0 is considered SUCCESS and anything else a FAILURE. If your previous implementation of the TAI returns a different error status you can either change your implementation to match the expectations or do one of the following.
1) Add the property com.ibm.websphere.security.trustassociation.initStatus in the Trust Association Interceptor custom properties and set it to the value that indicates SUCCESS in your implementation. All other values imply failure. In case of failure, the corresponding TAI implementation will not be used. OR 2) Add the property com.ibm.websphere.security.trustassociation.ignoreInitStatus in the Trust Association Interceptor custom properties and set it to true to indicate to WebSphere to ignore the status of this method. In this case WebSphere will not check the return status from this method just like in the earlier versions.
public int init(java.lang.String propsfile)
If the above init(Properties) method has been implemented by the TAI implementation, this method is not required to be implemented.
Initializes the Trust Association Interceptor implementation using properties read from a file. This methodwould make the previous Custom TAI implementations to work without any code changes.
propsfile
- the file containing the properties with which
to initialize the Custom Trust Association
Interceptor implementation.This method will be called ONLY when both the following conditions are satisfied.
1) The Custom TAI implementation has any properties set. 2) If the init(Properties) method described above is not implemented by the Custom TAI implementation.
Note that it is recommended that you change your previous implementation of the TAI(if any) to implement the init(Properties) method so that this method is not called.
If for any reason, one needs to keep using this method instead of the init(Properties) method, you need to keep the following two things in mind.
1) The file containing the Custom TAI properties can be set by setting eithera) com.ibm.websphere.security.trustassociation.initPropsFile property in the Trust Association Custom properties to the location of the file. For example, com.ibm.websphere.security.trustassociation.initPropsFile=c:/WebSphere/AppServer/properties/myTAI.properties. OR b) by using the property names used in the previous version of TAI. In this case the file name is obtained by concatenating the .config to the com.ibm.websphere.security.trustassociation.types property value. For example, if the file name is called myTAI.properties and is located in the C:/WebSphere/AppServer/properties directory, then set the following properties in the Trust Association Custom properties: com.ibm.websphere.security.trustassociation.types = myTAItype com.ibm.websphere.security.trustassociation.myTAItype.config = C:/WebSphere/AppServer/properties/myTAI.properties One can also use the variables ${USER_INSTALL_ROOT} or ${WAS_INSTALL_ROOT} to indicate the WebSphere installed directory location.2) Note that the error status that is returned by this method is now being used (unlike in the previous versions) to determine if the implementation will be used or not. A return of 0 is considered SUCCESS and anything else a FAILURE. If your previous implementation of the TAI returns different error status you can either change your implementation to match the expectations OR do one of the following.
a) Add the property com.ibm.websphere.security.trustassociation.initStatus in the Trust Association Interceptor custom properties and set it to the value that indicates success in your implementation. All other values imply failure. In case of failure the corresponding TAI implementation will not be used. OR b) Add the property com.ibm.websphere.security.trustassociation.ignoreInitStatus in the Trust Association Interceptor custom properties and set it to true to indicate to WebSphere to ignore the status of this method. In this case WebSphere will not check the return status from this method just like in the earlier versions.
public abstract void cleanup()
public void setVersion(java.lang.String s)
s
- Version number.public java.lang.String getVersion()
public void setType(java.lang.String t)
t
- typepublic java.lang.String getType()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |