/*
COPYRIGHT STATUS:
Dec 1st 2001, Fermi National Accelerator Laboratory (FNAL) documents and
software are sponsored by the U.S. Department of Energy under Contract No.
DE-AC02-76CH03000. Therefore, the U.S. Government retains a world-wide
non-exclusive, royalty-free license to publish or reproduce these documents
and software for U.S. Government purposes. All documents and software
available from this server are protected under the U.S. and Foreign
Copyright Laws, and FNAL reserves all rights.
Distribution of the software available from this server is free of
charge subject to the user following the terms of the Fermitools
Software Legal Information.
Redistribution and/or modification of the software shall be accompanied
by the Fermitools Software Legal Information (including the copyright
notice).
The user is asked to feed back problems, benefits, and/or suggestions
about the software to the Fermilab Software Providers.
Neither the name of Fermilab, the URA, nor the names of the contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
DISCLAIMER OF LIABILITY (BSD):
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL FERMILAB,
OR THE URA, OR THE U.S. DEPARTMENT of ENERGY, OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Liabilities of the Government:
This software is provided by URA, independent from its Prime Contract
with the U.S. Department of Energy. URA is acting independently from
the Government and in its own private capacity and is not acting on
behalf of the U.S. Government, nor as its contractor nor its agent.
Correspondingly, it is understood and agreed that the U.S. Government
has no connection to this software and in no manner whatsoever shall
be liable for nor assume any responsibility or obligation for any claim,
cost, or damages arising out of or resulting from the use of the software
available from this server.
Export Control:
All documents and software available from this server are subject to U.S.
export control laws. Anyone downloading information from this server is
obligated to secure any necessary Government licenses before exporting
documents or software obtained from this server.
*/
/*
* RemoteTurlGetter.java
*
* Created on April 30, 2003, 2:38 PM
*/
package org.dcache.srm.client;
import org.apache.axis.types.URI;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.xml.rpc.ServiceException;
import java.beans.PropertyChangeListener;
import java.io.IOException;
import java.net.URISyntaxException;
import java.rmi.RemoteException;
import java.util.HashMap;
import diskCacheV111.srm.RequestFileStatus;
import diskCacheV111.srm.RequestStatus;
import org.dcache.srm.AbstractStorageElement;
import org.dcache.srm.SRMException;
import org.dcache.srm.request.RequestCredential;
import org.dcache.srm.util.RequestStatusTool;
import org.dcache.srm.util.SrmUrl;
import org.dcache.srm.v2_2.ArrayOfAnyURI;
import org.dcache.srm.v2_2.ArrayOfString;
import org.dcache.srm.v2_2.ArrayOfTPutFileRequest;
import org.dcache.srm.v2_2.ArrayOfTPutRequestFileStatus;
import org.dcache.srm.v2_2.ISRM;
import org.dcache.srm.v2_2.SrmPrepareToPutRequest;
import org.dcache.srm.v2_2.SrmPrepareToPutResponse;
import org.dcache.srm.v2_2.SrmPutDoneRequest;
import org.dcache.srm.v2_2.SrmPutDoneResponse;
import org.dcache.srm.v2_2.SrmStatusOfPutRequestRequest;
import org.dcache.srm.v2_2.SrmStatusOfPutRequestResponse;
import org.dcache.srm.v2_2.TAccessLatency;
import org.dcache.srm.v2_2.TAccessPattern;
import org.dcache.srm.v2_2.TConnectionType;
import org.dcache.srm.v2_2.TFileStorageType;
import org.dcache.srm.v2_2.TOverwriteMode;
import org.dcache.srm.v2_2.TPutFileRequest;
import org.dcache.srm.v2_2.TPutRequestFileStatus;
import org.dcache.srm.v2_2.TRetentionPolicy;
import org.dcache.srm.v2_2.TRetentionPolicyInfo;
import org.dcache.srm.v2_2.TReturnStatus;
import org.dcache.srm.v2_2.TStatusCode;
import org.dcache.srm.v2_2.TTransferParameters;
/**
*
* @author timur
*/
public final class RemoteTurlPutterV2 extends TurlGetterPutter
{
private static final Logger logger =
LoggerFactory.getLogger(RemoteTurlPutterV2.class);
private ISRM srmv2;
private String requestToken;
private final String targetSpaceToken;
private final HashMap<String,Integer> pendingSurlsToIndex = new HashMap<>();
SrmPrepareToPutResponse srmPrepareToPutResponse;
final Transport transport;
protected final String[] SURLs;
private final String caCertificatePath;
protected final int number_of_file_reqs;
protected boolean createdMap;
final long[] sizes;
final long retry_timout;
final long requestLifetime;
final int retry_num;
private final TFileStorageType storageType;
private final TRetentionPolicy retentionPolicy;
private final TAccessLatency accessLatency;
private final TOverwriteMode overwriteMode;
public RemoteTurlPutterV2(AbstractStorageElement storage,
RequestCredential credential, String[] SURLs,
long sizes[],
String[] protocols,
PropertyChangeListener listener,
long retry_timeout,
int retry_num,
long requestLifetime,
TFileStorageType storageType,
TRetentionPolicy retentionPolicy,
TAccessLatency accessLatency,
TOverwriteMode overwriteMode,
String targetSpaceToken,
String caCertificatePath, Transport transport) {
super(storage,credential,protocols);
this.SURLs = SURLs;
this.caCertificatePath = caCertificatePath;
this.number_of_file_reqs = SURLs.length;
addListener(listener);
this.sizes = sizes;
this.retry_num = retry_num;
this.retry_timout = retry_timeout;
this.requestLifetime = requestLifetime;
this.storageType = storageType;
this.accessLatency = accessLatency;
this.retentionPolicy = retentionPolicy;
this.overwriteMode = overwriteMode;
this.targetSpaceToken = targetSpaceToken;
this.transport = transport;
}
protected void putDone(String surl) throws RemoteException,URI.MalformedURIException{
URI surlArray[] = new URI[1];
SrmPutDoneRequest srmPutDoneRequest = new SrmPutDoneRequest();
srmPutDoneRequest.setRequestToken(requestToken);
srmPutDoneRequest.setArrayOfSURLs(new ArrayOfAnyURI(surlArray));
SrmPutDoneResponse srmPutDoneResponse =
srmv2.srmPutDone(srmPutDoneRequest);
TReturnStatus returnStatus = srmPutDoneResponse.getReturnStatus();
if(returnStatus == null) {
logger.error("srmPutDone return status is null");
return;
}
logger.debug("srmPutDone status code="+returnStatus.getStatusCode());
}
@Override
public void getInitialRequest() throws SRMException {
if(number_of_file_reqs == 0) {
logger.debug("number_of_file_reqs is 0, nothing to do");
return;
}
try {
java.net.URI srmUrl = SrmUrl.createWithDefaultPort(SURLs[0]);
srmv2 = new SRMClientV2(srmUrl,
credential.getDelegatedCredential(),
retry_timout,
retry_num,
false,
false,
caCertificatePath,
transport);
int len = SURLs.length;
TPutFileRequest fileRequests[] = new TPutFileRequest[len];
for(int i = 0; i < len; ++i) {
URI uri =
new URI(SURLs[i]);
fileRequests[i] = new TPutFileRequest();
fileRequests[i].setTargetSURL(uri);
pendingSurlsToIndex.put(SURLs[i],i);
}
SrmPrepareToPutRequest srmPrepareToPutRequest = new SrmPrepareToPutRequest();
if(retentionPolicy != null || accessLatency != null) {
TRetentionPolicyInfo retentionPolicyInfo
= new TRetentionPolicyInfo();
retentionPolicyInfo.setRetentionPolicy(retentionPolicy);
retentionPolicyInfo.setAccessLatency(accessLatency);
srmPrepareToPutRequest.setTargetFileRetentionPolicyInfo(retentionPolicyInfo);
}
TTransferParameters transferParameters =
new TTransferParameters();
transferParameters.setAccessPattern(TAccessPattern.TRANSFER_MODE);
transferParameters.setConnectionType(TConnectionType.WAN);
transferParameters.setArrayOfTransferProtocols(new ArrayOfString(protocols));
srmPrepareToPutRequest.setTransferParameters(transferParameters);
srmPrepareToPutRequest.setArrayOfFileRequests(
new ArrayOfTPutFileRequest(fileRequests));
srmPrepareToPutRequest.setDesiredFileStorageType(storageType);
srmPrepareToPutRequest.setDesiredTotalRequestTime((int)requestLifetime);
srmPrepareToPutRequest.setOverwriteOption(overwriteMode);
srmPrepareToPutRequest.setTargetSpaceToken(targetSpaceToken);
srmPrepareToPutResponse = srmv2.srmPrepareToPut(srmPrepareToPutRequest);
}
catch(URISyntaxException | IOException | InterruptedException | ServiceException e) {
logger.error("failed to connect to {} {}",SURLs[0],e.getMessage());
throw new SRMException("failed to connect to "+SURLs[0],e);
}
}
@Override
public void run() {
if(number_of_file_reqs == 0) {
logger.debug("number_of_file_reqs is 0, nothing to do");
return;
}
try {
int len = SURLs.length;
if(srmPrepareToPutResponse == null) {
throw new IOException(" null srmPrepareToPutResponse");
}
TReturnStatus status = srmPrepareToPutResponse.getReturnStatus();
if(status == null) {
throw new IOException(" null return status");
}
TStatusCode statusCode = status.getStatusCode();
if(statusCode == null) {
throw new IOException(" null status code");
}
if(RequestStatusTool.isFailedRequestStatus(status)){
throw new IOException("srmPrepareToPut submission failed, unexpected or failed status : "+
statusCode+" explanation="+status.getExplanation());
}
requestToken = srmPrepareToPutResponse.getRequestToken();
logger.debug(" srm returned requestToken = "+requestToken+" one of remote surls = "+SURLs[0]);
ArrayOfTPutRequestFileStatus arrayOfTPutRequestFileStatus =
srmPrepareToPutResponse.getArrayOfFileStatuses();
if(arrayOfTPutRequestFileStatus == null ) {
throw new IOException("returned PutRequestFileStatuses is an empty array");
}
TPutRequestFileStatus[] putRequestFileStatuses =
arrayOfTPutRequestFileStatus.getStatusArray();
if(putRequestFileStatuses == null ) {
throw new IOException("returned PutRequestFileStatuses is an empty array");
}
if(putRequestFileStatuses.length != len) {
throw new IOException("incorrect number of GetRequestFileStatuses"+
"in RequestStatus expected "+len+" received "+
putRequestFileStatuses.length);
}
boolean haveCompletedFileRequests = false;
while(!pendingSurlsToIndex.isEmpty()) {
long estimatedWaitInSeconds = Integer.MAX_VALUE;
for(TPutRequestFileStatus putRequestFileStatus: putRequestFileStatuses) {
URI surl = putRequestFileStatus.getSURL();
if(surl == null) {
logger.error("invalid putRequestFileStatus, surl is null");
continue;
}
String surl_string = surl.toString();
if(!pendingSurlsToIndex.containsKey(surl_string)) {
logger.error("invalid putRequestFileStatus, surl = "+surl_string+" not found");
continue;
}
TReturnStatus fileStatus = putRequestFileStatus.getStatus();
if(fileStatus == null) {
throw new IOException(" null file return status");
}
TStatusCode fileStatusCode = fileStatus.getStatusCode();
if(fileStatusCode == null) {
throw new IOException(" null file status code");
}
if(RequestStatusTool.isFailedFileRequestStatus(fileStatus)){
String error ="retreval of surl "+surl_string+" failed, status = "+fileStatusCode+
" explanation="+fileStatus.getExplanation();
logger.error(error);
int indx = pendingSurlsToIndex.remove(surl_string);
notifyOfFailure(SURLs[indx], error, requestToken, null);
haveCompletedFileRequests = true;
continue;
}
if(putRequestFileStatus.getTransferURL() != null ) {
String turl = putRequestFileStatus.getTransferURL().toString();
int indx = pendingSurlsToIndex.remove(surl_string);
// in case of put we do not need the size from the destination
notifyOfTURL(SURLs[indx], turl,requestToken,null,null);
continue;
}
if(putRequestFileStatus.getEstimatedWaitTime() != null &&
putRequestFileStatus.getEstimatedWaitTime() < estimatedWaitInSeconds &&
putRequestFileStatus.getEstimatedWaitTime() >=1) {
estimatedWaitInSeconds = putRequestFileStatus
.getEstimatedWaitTime();
}
}
if(pendingSurlsToIndex.isEmpty()) {
logger.debug("no more pending transfers, breaking the loop");
break;
}
// do not wait longer then 60 seconds
if(estimatedWaitInSeconds > 60) {
estimatedWaitInSeconds = 60;
}
try {
logger.debug("sleeping "+estimatedWaitInSeconds+" seconds ...");
Thread.sleep(estimatedWaitInSeconds * 1000);
}
catch(InterruptedException ie) {
}
SrmStatusOfPutRequestRequest srmStatusOfPutRequestRequest =
new SrmStatusOfPutRequestRequest();
srmStatusOfPutRequestRequest.setRequestToken(requestToken);
// if we do not have completed file requests
// we want to get status for all files
// we do not need to specify any surls
int expectedResponseLength;
if(haveCompletedFileRequests){
String [] pendingSurlStrings =
pendingSurlsToIndex.keySet()
.toArray(new String[pendingSurlsToIndex.size()]);
expectedResponseLength= pendingSurlStrings.length;
URI surlArray[] =
new URI[expectedResponseLength];
for(int i=0;i<expectedResponseLength;++i){
URI uri =
new URI(pendingSurlStrings[i]);
surlArray[i]=uri;
}
srmStatusOfPutRequestRequest.setArrayOfTargetSURLs(
new ArrayOfAnyURI(surlArray));
}
else {
expectedResponseLength = SURLs.length;
URI surlArray[] = new URI[expectedResponseLength];
for(int i=0;i<expectedResponseLength;++i){
URI surl = new URI(SURLs[i]);
surlArray[i]=surl;
}
srmStatusOfPutRequestRequest.setArrayOfTargetSURLs(
new ArrayOfAnyURI(surlArray));
}
SrmStatusOfPutRequestResponse srmStatusOfPutRequestResponse =
srmv2.srmStatusOfPutRequest(srmStatusOfPutRequestRequest);
if(srmStatusOfPutRequestResponse == null) {
throw new IOException(" null srmStatusOfPutRequestResponse");
}
arrayOfTPutRequestFileStatus =
srmStatusOfPutRequestResponse.getArrayOfFileStatuses();
if(arrayOfTPutRequestFileStatus == null ) {
throw new IOException("incorrect number of RequestFileStatuses");
}
putRequestFileStatuses =
arrayOfTPutRequestFileStatus.getStatusArray();
if(putRequestFileStatuses == null ||
putRequestFileStatuses.length != expectedResponseLength) {
logger.error( "incorrect number of RequestFileStatuses");
throw new IOException("incorrect number of RequestFileStatuses");
}
status = srmStatusOfPutRequestResponse.getReturnStatus();
if(status == null) {
throw new IOException(" null return status");
}
statusCode = status.getStatusCode();
if(statusCode == null) {
throw new IOException(" null status code");
}
if(RequestStatusTool.isFailedRequestStatus(status)){
throw new IOException("srmPrepareToPut update failed, unexpected or failed status : "+
statusCode+" explanation="+status.getExplanation());
}
}
}
catch(IOException ioe) {
logger.error(ioe.toString());
notifyOfFailure(ioe);
}
}
public static RequestFileStatus getFileRequest(RequestStatus rs,Integer nextID) {
RequestFileStatus[] frs = rs.fileStatuses;
if(frs == null ) {
return null;
}
for (RequestFileStatus fr : frs) {
if (fr.fileId == nextID) {
return fr;
}
}
return null;
}
public static void staticPutDone(RequestCredential credential,
String surl,
String requestToken,
long retry_timeout,
int retry_num,
String caCertificatePath, Transport transport) throws Exception
{
java.net.URI srmUrl = SrmUrl.createWithDefaultPort(surl);
SRMClientV2 srmv2 = new SRMClientV2(srmUrl,
credential.getDelegatedCredential(),
retry_timeout,
retry_num,
false,
false,
caCertificatePath,
transport);
URI surlArray[] = new URI[1];
surlArray[0]= new URI(surl);
SrmPutDoneRequest srmPutDoneRequest = new SrmPutDoneRequest();
srmPutDoneRequest.setRequestToken(requestToken);
srmPutDoneRequest.setArrayOfSURLs(new ArrayOfAnyURI(surlArray));
SrmPutDoneResponse srmPutDoneResponse =
srmv2.srmPutDone(srmPutDoneRequest);
TReturnStatus returnStatus = srmPutDoneResponse.getReturnStatus();
if(returnStatus == null) {
logger.error("srmPutDone return status is null");
return;
}
logger.debug("srmPutDone status code="+returnStatus.getStatusCode());
}
}