Access Keys:
Skip to content (Access Key - 0)

CaGrid 1.4 Deprecation Plan

The final version of this page will exist in the cagrid 1.4 space. That document is the official source of authority for the deprecation plan, however it is virtually identical to this one for community reference until the 1.4 release is made
Contents

Overview

This document provides the deprecation plan for caGrid 1.4, in adherence with the deprecation policy.

Stable APIs

A Stable API is one in which there may be additional methods, but no existing public method signatures will change, nor will the runtime behavior change.

As a general philosophy on backwards compatibility, caGrid has always attempted to maintain service-level backwards compatibility of its core service along the caGrid 1.x release stream. That is, the client API of a core service from a given 1.x release should be able to communicate with a service running 1.x or newer code. We are continuing this general philosophy in this specific plan (with exceptions noted below), but making it explicit and also maintaining backwards compatibility to additional useful APIs. The items enumerated in this list represent the APIs and other items which can be considered stable and backwards compatible in the caGrid 1.4 release.

NOTE: The omission of an API from the Stable list does not necessarily mean use of the API should be avoided or it will change in the release, but rather that its stability between releases is not currently considered a requirement (as of the caGrid 1.2 release, there were 2791 Classes in the published javadocs; complete backwards compatibility is not feasible). If you have concerns with a particular omission, please contact the development team for its consideration into future deprecation plans.

Core Service Interfaces (WSDL Operations)

Index Service

Main Service

  • WS-Resource Lifetime:
    • SetTerminationTime
    • Destroy
  • WS-ResourceProperties:
    • QueryResourceProperties
    • GetMultipleResourceProperties
    • GetResourceProperty
  • WS-ServiceGroup:
    • Add
    • create
  • WS-Notification:
    • Subscribe
    • GetCurrentMessage

Entry Service

  • WS-Resource Lifetime:
    • SetTerminationTime
  • WS-ResourceProperties:
    • QueryResourceProperties
    • GetMultipleResourceProperties
    • GetResourceProperty

Grid Trust Service (GTS)

Main Service

  • Service Security:
    • getServiceSecurityMetadata
  • WS-ResourceProperties:
    • QueryResourceProperties
    • GetMultipleResourceProperties
    • GetResourceProperty
  • GTS
    • addTrustedAuthority
    • findTrustedAuthorities
    • removeTrustedAuthority
    • addPermission
    • findPermissions
    • revokePermission
    • updateTrustedAuthority
    • addTrustLevel
    • updateTrustLevel
    • getTrustLevels
    • removeTrustLevel
    • addAuthority
    • updateAuthority
    • updateAuthorityPriorities
    • getAuthorities
    • removeAuthority
    • updateCRL
    • validate

Grid Grouper

Main Service

  • Service Security:
    • getServiceSecurityMetadata
  • WS-ResourceProperties:
    • QueryResourceProperties
    • GetMultipleResourceProperties
    • GetResourceProperty
  • Grid Grouper
    • getStem
    • getChildStems
    • getParentStem
    • updateStem
    • getSubjectsWithStemPrivilege
    • getStemPrivileges
    • hasStemPrivilege
    • grantStemPrivilege
    • revokeStemPrivilege
    • addChildStem
    • deleteStem
    • getGroup
    • getChildGroups
    • addChildGroup
    • deleteGroup
    • updateGroup
    • addMember
    • getMembers
    • isMemberOf
    • getMemberships
    • deleteMember
    • addCompositeMember
    • deleteCompositeMember
    • grantGroupPrivilege
    • revokeGroupPrivilege
    • getSubjectsWithGroupPrivilege
    • getGroupPrivileges
    • hasGroupPrivilege
    • isMember
    • getMember
    • getMembersGroups

Dorian

Main Service

  • Service Security:
    • getServiceSecurityMetadata
  • WS-ResourceProperties:
    • QueryResourceProperties
    • GetMultipleResourceProperties
    • GetResourceProperty
  • Local Identity Provider
    • registerWithIdP
    • authenticate
  • Federation
    • createProxy
    • requestHostCertificate
    • getOwnedHostCertificates

Authentication Service

Main Service

  • Service Security:
    • getServiceSecurityMetadata
  • WS-ResourceProperties:
    • QueryResourceProperties
    • GetMultipleResourceProperties
    • GetResourceProperty
  • Authentication Service
    • authenticate

Credential Delegation Service (CDS)

Main Service

  • Service Security:
    • getServiceSecurityMetadata
  • WS-ResourceProperties:
    • QueryResourceProperties
    • GetMultipleResourceProperties
    • GetResourceProperty
  • CDS
    • initiateDelegation
    • approveDelegation
    • findDelegatedCredentials
    • updateDelegatedCredentialStatus
    • findCredentialsDelegatedToClient
    • searchDelegatedCredentialAuditLog
    • deleteDelegatedCredential
    • addAdmin
    • removeAdmin
    • getAdmins

Delegated Credential Resource

  • Service Security:
    • getServiceSecurityMetadata
  • WS-ResourceProperties:
    • QueryResourceProperties
    • GetMultipleResourceProperties
    • GetResourceProperty
  • Delegated Credential
    • getDelegatedCredential

Federated Query Processor Service (FQP)

Main Service

  • Service Security:
    • getServiceSecurityMetadata
  • WS-ResourceProperties:
    • QueryResourceProperties
    • GetMultipleResourceProperties
    • GetResourceProperty
  • FQP
    • execute
    • executeAndAggregateResults
    • executeAsynchronously

Results Service

  • Service Security:
    • getServiceSecurityMetadata
  • WS-ResourceProperties:
    • QueryResourceProperties
    • GetMultipleResourceProperties
    • GetResourceProperty
  • WS-Resource Lifetime:
    • SetTerminationTime
    • Destroy
  • FQP
    • getResults
    • isProcessingComplete

Transfer Service Context

  • getDataTransferDescriptor
  • getStatus
  • setStatus
  • Service Security
    • getServiceSecurityMetadata
  • WS-Lifetime
    • Destroy
    • SetTerminationTime
  • WS-Notification
    • Subscribe

Provided Operations (WSDL Operations)

Bulk Data Transfer Service (BDT)

  • CreateEnumeration
  • GetGridFTPURLs
  • PullOp
  • RenewOp
  • GetStatusOp
  • ReleaseOp
  • Get
  • WS-Lifetime
    • Destroy
    • SetTerminationTime
  • WS-ResourceProperties:
    • QueryResourceProperties
    • GetMultipleResourceProperties
    • GetResourceProperty
BDT operations will persist in services which make use of it, however the BDT service and extension to Introduce are deprecated since the 1.3 release and no further updates will be provided for this service. See the BDT page for more information.

WS-Enumeration

  • PullOp
  • RenewOp
  • GetStatusOp
  • ReleaseOp
  • WS-ResourceProperties:
    • QueryResourceProperties
    • GetMultipleResourceProperties
    • GetResourceProperty

Data Services

  • query

BDT Data Services

  • bdtQuery

Enumeration Data Services

  • enumerationQuery

WS-Lifetime

  • Destroy
  • SetTerminationTime

WS-Notification

  • Subscribe

Web Service Resource Properties

  • QueryResourceProperties
  • GetMultipleResourceProperties
  • GetResourceProperty

Service Security Provider

  • getServiceSecurityMetadata

Client APIs

gov.nih.nci.cagrid.advertisement.AdvertisementClient

  • All public methods

gov.nih.nci.cagrid.advertisement.TerminationClient

  • All public methods

gov.nih.nci.cagrid.discovery.client.DiscoveryClient

  • All public methods

gov.nih.nci.cagrid.authentication.client.AuthenticationClient

  • All public methods

gov.nih.nci.cagrid.dorian.client.IdPRegistrationClient

  • All public methods

gov.nih.nci.cagrid.dorian.client.IdPUserClient

  • All public methods

gov.nih.nci.cagrid.dorian.client.IFSUserClient

  • All public methods

gov.nih.nci.cagrid.gts.client.GTSPublicClient

  • All public methods

gov.nih.nci.cagrid.gts.client.GTSAdminClient

  • All public methods

gov.nih.nci.cagrid.syncgts.core.SyncGTS

  • All public methods

gov.nih.nci.cagrid.gridgrouper.client.GridGrouper

  • All public methods

gov.nih.nci.cagrid.gridgrouper.client.Group

  • All public methods

gov.nih.nci.cagrid.gridgrouper.client.Member

  • All public methods

gov.nih.nci.cagrid.gridgrouper.client.Membership

  • All public methods

gov.nih.nci.cagrid.gridgrouper.client.NamingPrivilege

  • All public methods

gov.nih.nci.cagrid.gridgrouper.client.Stem

  • All public methods

org.cagrid.gaards.cds.client.DelegationUserClient

  • All public methods

org.cagrid.gaards.cds.client.DelegationAdminClient

  • All public methods

org.cagrid.gaards.cds.client.DelegatedCredentialUserClient

  • All public methods

gov.nih.nci.cagrid.fqp.client.FederatedQueryProcessorClient

  • All public methods

gov.nih.nci.cagrid.fqp.results.client.FederatedQueryResultsClient

  • All public methods

gov.nih.nci.cagrid.data.client.DataServiceClient

  • All public methods

gov.nih.nci.cagrid.data.enumeration.client.EnumerationDataServiceClient

  • All public methods

gov.nih.nci.cagrid.data.bdt.client.BDTDataServiceClient

  • All public methods

Utility APIs

Transfer Services

org.cagrid.transfer.context.client.helper.TransferClientHelper

  • All public methods

org.cagrid.transfer.context.service.helper.TransferServiceHelper

  • All public methods

Data Services

gov.nih.nci.cagrid.data.cql.validation.DomainModelValidator

  • All public methods

gov.nih.nci.cagrid.data.cql.validation.JaxPCqlValidator

  • All public methods

gov.nih.nci.cagrid.data.cql.validation.ObjectWalkingCQLValidator

  • All public methods

gov.nih.nci.cagrid.data.utilities.* (All Utility Classes)

  • All public methods

gov.nih.nci.cagrid.data.service.BaseServiceImpl

  • All public methods
  • Of interest to extenders
    • Minor changes to fix bugs and add logging

gov.nih.nci.cagrid.data.cql.CQLQueryProcessor

  • All public and protected methods

gov.nih.nci.cagrid.data.cql.LazyCQLQueryProcessor

  • All public and protected methods

WS-Enumeration

gov.nih.nci.cagrid.wsenum.utils.EnumIteratorFactory

  • All public methods

gov.nih.nci.cagrid.wsenum.utils.EnumerationResponseHelper

  • All public methods
  • Addition versions of existing public methods have been added

Other

gov.nih.nci.cagrid.metadata.MetadataUtils

  • All public methods

gov.nih.nci.cagrid.gridgrouper.client.GridGrouperClientUtils

  • All public methods

Introduce

Utility API

gov.nih.nci.cagrid.introduce.common.CommonTools

    • All public methods

Common API

  • gov.nih.nci.cagrid.introduce.common.ImportInformation
  • gov.nih.nci.cagrid.introduce.common.NamespaceInformation
  • gov.nih.nci.cagrid.introduce.common.SchemaInformation
  • gov.nih.nci.cagrid.introduce.common.ServiceInformation
  • gov.nih.nci.cagrid.introduce.common.SpecificMethodInformation
  • gov.nih.nci.cagrid.introduce.common.SpecificServiceInformation

Extension API

Deployment

  • gov.nih.nci.cagrid.introduce.portal.extension.DeploymentUIPanel

Discovery

  • gov.nih.nci.cagrid.introduce.portal.modification.discovery.NamespaceTypeDiscoveryComponent
  • gov.nih.nci.cagrid.introduce.portal.discoverytools.NamespaceTypeToolsComponent

Service

  • gov.nih.nci.cagrid.introduce.extension.CodegenExtensionException
  • gov.nih.nci.cagrid.introduce.extension.CodegenExtensionPostProcessor
  • gov.nih.nci.cagrid.introduce.extension.CodegenExtensionPreProcessor
  • gov.nih.nci.cagrid.introduce.extension.CreationExtensionException
  • gov.nih.nci.cagrid.introduce.extension.CreationExtensionPostProcessor
  • gov.nih.nci.cagrid.introduce.portal.extension.CreationExtensionUIDialog
  • gov.nih.nci.cagrid.introduce.portal.extension.ServiceDeploymentUIPanel
  • gov.nih.nci.cagrid.introduce.portal.extension.ServiceModificationUIPanel
  • gov.nih.nci.cagrid.introduce.upgrade.common.ExtensionUpgraderI

Other

WebSSO-Client-Acegi:
An application that uses the default implementation of WebSSO Acegi Client must extend the abstract class org.cagrid.websso.client.acegi.BaseUserDetailsService and implement the abstract protected method loadUserByGridId(String gridId) method to load the following User information accountenabled/disabled, accountNonExpired/accountexpired, credentialsNonExpired/credentialsExpired, accountNonLocked/accountlocked and the authorities from database using CSM or Data Access Service.

org.cagrid.websso.client.acegi.BaseUserDetailsService

  • abstract protected WebSSOUser loadUserByGridId(String gridId)

caGrid Standard Metadata Models

  • The following main Class models and all associated Classes of:
    • gov.nih.nci.cagrid.metadata.ServiceMetadata
    • gov.nih.nci.cagrid.metadata.dataservice.DomainModel
    • gov.nih.nci.cagrid.metadata.security.ServiceSecurityMetadata

Deprecated Services

No deprecated services

Retired Services

The following caGrid core services will be retired with the 1.4 release:

  • authz
  • bdt
    • gridftpauthz included
  • workflow factory service

BDT

Reason for retirement

BDT has been replaced by caGrid Transfer as of caGrid 1.2, and was deprecated with the 1.3 release. Because we have very limited use of the BDT service and heavy adoption of the Transfer service we have decided to enhance our support for the Transfer service and depricate the BDT service.

Migration Plan

The caGrid Transfer contains a tutorial on how to effectively and easily create data transfers with its API and services.

authz

Reason for Retirement

The authz service made use of a deprecated version of the CSM and has been superseded by the CSM grid service.
*Additional discussion

Migration Plan

The CSM service provides similar functionality and contains appropriate guides for administrators and developers.

gridftpauthz

Reason for retirement

The GridFTPauthz service and APIs were useful for securing GridFTP in the context of the Bulk Data Transfer (BDT) services of caGrid. As BDT has been retired from this release, gridftpauthz is no longer used or needed.

Workflow factory service

Reason for retirement

The BPEL workflow service and associated workflow factory service have been removed from caGrid 1.4 and replaced by Taverna workflow services.

Migration Plan

The Taverna Workflow Service contains tutorials and quickstart guides to effectively create and utilize workflows in caGrid.

Grid Protocol Changes

There are no expected grid protocol/specification changes for this release.

The current stable release of the Globus toolkit (version 4.2), introduces incompatible specification changes, but caGrid 1.4 will not make use of that release. A brief impact analysis of such a migration can be found here.
Last edited by
David Ervin (513 days ago) , ...
Adaptavist Theme Builder Powered by Atlassian Confluence