Oracle Entitlements Server for Java API Reference: Class PublicSecurityService

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Oracle Entitlements Server for Java API Reference

com.bea.security
Class PublicSecurityService

java.lang.Object
  |
  +--com.bea.security.PublicSecurityService

Direct Known Subclasses:: AuditingService, AuthenticationService, AuthorizationService, CredentialMappingService, RoleService

public abstract class PublicSecurityService
extends java.lang.Object

This base class is used for all security service providers to indicate their type and revision.

Author:: Copyright © 2004-2008, Oracle and/or its affiliates. All rights reserved.

Field Summary
`int`	`COMPATIBLE` A flag that indicates this service is fully compatible
`int`	`COMPATIBLE_DEPRECATED` A flag that indicates this service is fully compatible, but some interface elements will be changing in structure or funtion in the coming versions.
`int`	`COMPATIBLE_UNKNOWN` A flag that indicates that the compatibility of this interface is unknown.
`int`	`NOT_COMPATIBLE` A flag that indicates this service is not fully compatible.

Constructor Summary
`PublicSecurityService()`

Method Summary
`abstract ServiceType`	`getServiceType()` Return the type of this service.
`abstract ServiceVersion`	`getVersion()` Return the version of this service
`abstract int`	`isCompatible(ServiceVersion version)` Determines if the version of the public service API specified in the Java application is compatible with the current version in the security runtime instance.

Methods inherited from class java.lang.Object

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

Field Detail

NOT_COMPATIBLE

public final int NOT_COMPATIBLE

A flag that indicates this service is not fully compatible.

COMPATIBLE

public final int COMPATIBLE

A flag that indicates this service is fully compatible

COMPATIBLE_DEPRECATED

public final int COMPATIBLE_DEPRECATED

A flag that indicates this service is fully compatible, but some interface elements will be changing in structure or funtion in the coming versions.

COMPATIBLE_UNKNOWN

public final int COMPATIBLE_UNKNOWN

A flag that indicates that the compatibility of this interface is unknown.

Constructor Detail

PublicSecurityService

public PublicSecurityService()

Method Detail

getVersion

public abstract ServiceVersion getVersion()

Return the version of this service

Returns:: a ServiceVersion object indicating the version and patch level of this service.

getServiceType

public abstract ServiceType getServiceType()

Return the type of this service.

Returns:: a ServiceType object indicating the service type of this service

isCompatible

public abstract int isCompatible(ServiceVersion version)

Determines if the version of the public service API specified in the Java application is compatible with the current version in the security runtime instance.

Parameters:: version - a ServiceVersion which is being asked for by the Java application. The current service, that is, the service in the security runtime instance, will indiciate if it supports the version specified in the isCompatible() method.
Returns:: an int equaling NOT_COMPATIBLE if the service is not compatible with the supplied version, COMPATIBLE if the service is fully compatible, COMPATIBLE_DEPRECATED if the service is compatible, but some functions have been depricated between the versions, or, finally, COMPATIBLE_UNKNOWN if the version passed in is newer than the current version, so compatibility is unknown.