/*
* RHQ Management Platform
* Copyright (C) 2005-2013 Red Hat, Inc.
* All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation version 2 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
package org.rhq.bindings.util;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import javax.script.Bindings;
import javax.script.ScriptContext;
import javax.script.ScriptEngine;
import org.rhq.bindings.StandardBindings;
import org.rhq.bindings.client.RhqFacade;
import org.rhq.core.domain.auth.Subject;
import org.rhq.core.domain.criteria.ResourceCriteria;
import org.rhq.core.domain.criteria.ResourceOperationHistoryCriteria;
import org.rhq.core.domain.operation.OperationRequestStatus;
import org.rhq.core.domain.operation.ResourceOperationHistory;
import org.rhq.core.domain.operation.bean.ResourceOperationSchedule;
import org.rhq.core.domain.resource.Resource;
import org.rhq.core.domain.util.PageList;
import org.rhq.core.domain.util.PageOrdering;
import org.rhq.enterprise.server.content.ContentManagerRemote;
import org.rhq.enterprise.server.operation.OperationManagerRemote;
import org.rhq.enterprise.server.resource.ResourceManagerRemote;
/**
* Instance of this class is injected into the script engine scope.
*
* @author Lukas Krejci
*/
@SuppressWarnings("UnusedDeclaration")
public class ScriptUtil {
private RhqFacade remoteClient;
private ScriptEngine scriptEngine;
public ScriptUtil(RhqFacade remoteClient) {
this.remoteClient = remoteClient;
}
/**
* This method is called before the instance is inserted into the script engine scope.
*
* @param scriptEngine the script engine this instance is to be injected in
*/
@NoTopLevelIndirection
public void init(ScriptEngine scriptEngine) {
this.scriptEngine = scriptEngine;
}
/** This convenience method has been deprecated as it was not designed to support paging
* which is a requirement to efficiently handle large results sets. This methods returns
* all inexact matches to the String parameter passed in. Clients may have difficulty
* retrieving all results.
*
* Instead to page through large/small result sets you should create
* i)ResourceCriteria instances to be passed into
* ii)ResourceManager.findResourcesByCriteria(ResourceCriteria criteria)
*
* NOTE: ResourceCriteria by default has a page size of 200 and starts on page 0. Ex. criteria.setPaging(0,200);
*
* To iterate over a larger result set you can
* i)get access to the total number of resources, as the PageList<Resource> return includes a getTotalSize() method
* ii)iterate through the pages of results by using Ex. criteria.setPaging(1,200), criteria.setPaging(2,200), [N,PageSize]
*
* @param string
* @return PageList<Resource> Resources with inexact name matches to the string passed in.
*/
@Deprecated
public PageList<Resource> findResources(String string) {
if (remoteClient == null) {
throw new IllegalStateException("The findResources() method requires a connection to the RHQ server.");
}
ResourceManagerRemote resourceManager = remoteClient.getProxy(ResourceManagerRemote.class);
ResourceCriteria criteria = new ResourceCriteria();
criteria.addFilterName(string);
criteria.clearPaging();//disable paging as the code assumes all the results will be returned.
return resourceManager.findResourcesByCriteria(getSubjectFromEngine(), criteria);
}
public void saveBytesToFile(byte[] bytes, String filename) throws IOException {
FileOutputStream fos = new FileOutputStream(filename);
try {
fos.write(bytes);
} finally {
fos.close();
}
}
public byte[] getFileBytes(String fileName) {
File file = new File(fileName);
long length = file.length();
if (length > Integer.MAX_VALUE) {
throw new IllegalArgumentException("Can not read file larger than " + Integer.MAX_VALUE + " byte: "
+ fileName);
}
byte[] bytes;
InputStream is = null;
try {
bytes = new byte[(int) length];
is = new FileInputStream(file);
int offset = 0, bytesRead = 0;
for (offset = 0, bytesRead = 0; offset < bytes.length && bytesRead >= 0; offset += bytesRead) {
bytesRead = is.read(bytes, offset, bytes.length - offset);
}
if (offset < bytes.length) {
throw new RuntimeException("Could not read entire file " + file.getName() + ", only " + offset + " of "
+ bytes.length + " bytes read");
}
} catch (IOException ioe) {
throw new RuntimeException("Error reading file: " + ioe.getMessage());
} finally {
try {
if (is != null) {
is.close();
}
} catch (IOException ioe) {
throw new RuntimeException("Error closing file: " + ioe.getMessage());
}
}
return bytes;
}
public void sleep(long millis) {
try {
Thread.sleep(millis);
} catch (InterruptedException ie) {
throw new RuntimeException(ie);
}
}
public ResourceOperationHistory waitForScheduledOperationToComplete(ResourceOperationSchedule schedule)
throws InterruptedException{
return waitForScheduledOperationToComplete(schedule, 1000L, 10);
}
public ResourceOperationHistory waitForScheduledOperationToComplete(ResourceOperationSchedule schedule,
long intervalDuration,
int maxIntervals) throws InterruptedException {
if (remoteClient == null) {
throw new IllegalStateException("The waitForScheduledOperationToComplete() method requires a connection to the RHQ server.");
}
ResourceOperationHistoryCriteria criteria = new ResourceOperationHistoryCriteria();
criteria.addFilterJobId(schedule.getJobId());
criteria.addFilterResourceIds(schedule.getResource().getId());
criteria.addSortStartTime(PageOrdering.DESC);
criteria.setPaging(0, 1);
criteria.fetchOperationDefinition(true);
criteria.fetchParameters(true);
criteria.fetchResults(true);
ResourceOperationHistory history = null;
int i = 0;
while(history == null && i < maxIntervals) {
Thread.sleep(intervalDuration);
PageList<ResourceOperationHistory> histories = remoteClient.getProxy(OperationManagerRemote.class)
.findResourceOperationHistoriesByCriteria(remoteClient.getSubject(), criteria);
if (histories.size() > 0 && histories.get(0).getStatus() != OperationRequestStatus.INPROGRESS) {
history = histories.get(0);
}
++i;
}
return history;
}
public boolean isDefined(String identifier) {
Bindings engineBindings = scriptEngine.getBindings(ScriptContext.ENGINE_SCOPE);
Bindings globalBindings = scriptEngine.getBindings(ScriptContext.GLOBAL_SCOPE);
return engineBindings.containsKey(identifier) || globalBindings.containsKey(identifier);
}
private Subject getSubjectFromEngine() {
return (Subject) findBinding(StandardBindings.SUBJECT);
}
private Object findBinding(String identifier) {
Bindings engineBindings = scriptEngine.getBindings(ScriptContext.ENGINE_SCOPE);
Bindings globalBindings = scriptEngine.getBindings(ScriptContext.GLOBAL_SCOPE);
if (engineBindings.containsKey(identifier)) {
return engineBindings.get(identifier);
} else {
return globalBindings.get(identifier);
}
}
public String uploadContent(String filename) {
if (remoteClient == null) {
throw new IllegalStateException("The uploadContent method requires a connection to the RHQ server.");
}
ContentUploader contentUploader = new ContentUploader(remoteClient.getProxy(ContentManagerRemote.class));
return contentUploader.upload(filename);
}
}