Opening .doc files from IFS

Question

Hi,
I have a question about some functionality in the default web package with ifs. It is probably quite basic, but I am having difficulty with it. In the out of the box web ui, if I click on an uploaded .doc file, Microsoft Word gets loaded in my browser with the file openned.
I am using the JAVA API, and I have uploaded and foldered a .doc file. When I click on it, href="//computer/path/file.doc" word opens, but I get the file was not found.Any ideas?? Thank you.
Ian

Answer 1

Ian
The decision on which application the browser runs is taken by the browser based on information supplied in the HTTP response.
Here's an updated version of the RenderContent method that gives you some degree of control over this process...
// $Header$
* Please complete these missing tags
* @author
* @rref
* @copyright
* @concurrency
* @see
package ifs.pm.common.jsp;
import oracle.ifs.adk.http.HttpUtils;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import javax.servlet.ServletInputStream;
import oracle.ifs.beans.Selector;
import oracle.ifs.beans.Format;
import java.util.Enumeration;
import java.util.Locale;
import java.net.URLEncoder;
import java.lang.Class;
import java.lang.reflect.Method;
import java.lang.reflect.InvocationTargetException;
import oracle.ifs.adk.security.IfsHttpLogin;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.FileOutputStream;
import java.io.File;
import ifs.pm.common.trace.Alert;
import oracle.ifs.beans.LibraryObject;
import oracle.ifs.beans.ClassObject;
import oracle.ifs.beans.Document;
import oracle.ifs.beans.LibraryObjectDefinition;
import oracle.ifs.beans.Attribute;
import oracle.ifs.common.AttributeValue;
import oracle.ifs.beans.PublicObject;
import oracle.ifs.beans.FolderPathResolver;
import oracle.ifs.beans.LibrarySession;
import oracle.ifs.common.IfsException;
import oracle.ifs.beans.LibraryService;
import oracle.ifs.beans.LibrarySession;
import oracle.ifs.common.CleartextCredential;
import oracle.ifs.common.ConnectOptions;
import java.util.Hashtable;
import java.util.Date;
import java.text.SimpleDateFormat;
public class JspHelper extends Object
public static final String ACTION = "Action";
public static final String OPERATION = "Operation";
public static final String POLICY = "Policy";
public static final String MIMETYPE = "MimeType";
public static final String OPEN = "Open";
public static final String DOWNLOAD = "Download";
public static final String RENDER = "Render";
public static final String WEBLOGON = "/Login";
public static final String USERNAME = "username";
public static final String PASSWORD = "password";
public static final String SERVICE = "service";
public static final String SCHEMA_PASSWORD = "schemapassword";
public static final String IFSHTTPLOGIN = "IfsHttpLogin";
public static final String IFSWEBROOT = "/ifs/webui";
public static final String IFSTIMEOUT_URL = "/html/timeout.html";
private static String m_ServletPath = null;
private static final boolean DEBUG = true;
private static final String OPEN_SAVEAS_DIALOG = "oracleifs/download";
* Please complete the missing tags for JspHelper
* @param
* @return
* @throws
* @pre
* @post
private static Hashtable characterEncoding = new Hashtable();
static {
characterEncoding.put("+","%2B");
characterEncoding.put("#","%23");
characterEncoding.put("&","%26");
characterEncoding.put(" ","%20");
characterEncoding.put("'","%27");
characterEncoding.put(":","%3A");
characterEncoding.put("(","%28");
characterEncoding.put(")","%29");
characterEncoding.put("-","%2D");
private static String getServletPath()
return m_ServletPath;
public static String generateURL(Long id)
// Creates an Encoded URL from a Docid
String url = "";
if (getServletPath() != null) {
url = getServletPath();
url = url + "/";
url = url + (String) characterEncoding.get(":");
url = url + id.toString();
return url;
public static String generateURL(String path)
// Creates an Encoded URL from a Docid
String url = "";
if (getServletPath() != null) {
url = getServletPath();
if (!path.startsWith("/")) {
url = url + "/";
url = url + encodePath(path);
return url;
private static void setupServletPath(HttpServletRequest req)
// If never initialized, get the servlet path and store
// in the static
if ( null == m_ServletPath )
String contextPath = null;
String servletPath = "";
// Start with an empth string
m_ServletPath = "";
//let's figure out whether we're running under Servlet API 2.2
//or an earlier version
Class c = req.getClass();
try
//getContextPath() is first defined in 2.2
Method m = c.getMethod("getContextPath", null);
contextPath = (String)m.invoke(req, null);
catch (NoSuchMethodException e1)
catch (InvocationTargetException e2)
catch (IllegalAccessException e3)
if (DEBUG) {
Alert.log("JspHelper.setupServletPath(): contextPath = " + contextPath);
servletPath = req.getServletPath();
if (DEBUG) {
Alert.log("JspHelper.setupServletPath(): servletPath = " + servletPath);
if ( null != contextPath )
m_ServletPath = contextPath;
if ( null != servletPath )
m_ServletPath += servletPath;
else
if (DEBUG) {
Alert.log("JspHelper.setupServletPath(): not first time through.");
if (DEBUG) {
Alert.log ("JspHelper.setupServletPath(): m_ServletPath = " + m_ServletPath);
private static String getReposPath( HttpServletRequest request )
String result = null;
String path = request.getParameter(DOCUMENT_PATH);
if (null == path) {
path = request.getParameter(ALTERNATIVE_PATH);
return getReposPath(path);
public static String getReposPath(String path)
if (DEBUG) {
Alert.log ("JspHelper.getReposPath(request): Initial Path = " + path);
if (path != null) {
if ( ( null != getServletPath() ) && path.startsWith(getServletPath())) {
path = path.substring(getServletPath().length());
if (DEBUG) {
Alert.log ("JspHelper.getReposPath(request): Stripped Path = " + path);
path = undoSubstitutions(path);
if (DEBUG) {
Alert.log ("JspHelper.getReposPath(request): Converted Path = " + path);
if (DEBUG) {
Alert.log("JspHelper.getReposPath(request) Final Path = " + path);
return path;
public static String encodePath(String path)
// Substitute '%', then everything else
path = replaceString(path,"%","%25");
return doSubstitutions(path);
public static String decodePath(String path)
path = undoSubstitutions(path);
return replaceString(path,"%25","%");
public static String doSubstitutions(String path)
String encodedPath = path;
Enumeration keys = characterEncoding.keys();
while (keys.hasMoreElements()) {
String source = (String) keys.nextElement();
String target = (String) characterEncoding.get(source);
encodedPath = replaceString(encodedPath,source,target);
return encodedPath;
public static String undoSubstitutions(String path)
String encodedPath = path;
Enumeration keys = characterEncoding.keys();
while (keys.hasMoreElements()) {
String source = (String) keys.nextElement();
String target = (String) characterEncoding.get(source);
encodedPath = replaceString(encodedPath,target,source);
return encodedPath;
public static String getReposPath( HttpServletRequest request )
return HttpUtils.getIfsPathFromJSPRedirect(request);
public static String generateURL(HttpServletRequest request, Long id)
return HttpUtils.getURLFromIfsPath(request,":" + id.toString());
public static String generateURL(HttpServletRequest request, String path)
return HttpUtils.getURLFromIfsPath(request,path);
public JspHelper()
IfsException.setVerboseMessage( true );
* Please complete the missing tags for getArgumentAsString
* @param
* @return
* @throws
* @pre
* @post
public static String getArgumentAsString( Object arg )
if( null == arg )
return "";
else
return arg.toString();
* Please complete the missing tags for getArgumentAsString
* @param
* @return
* @throws
* @pre
* @post
public static String getArgumentAsString( String formatMask, Date arg )
if( null == arg )
return "";
else
SimpleDateFormat sdf = new SimpleDateFormat( formatMask );
return sdf.format( arg );
* Please complete the missing tags for getSession
* @param
* @return
* @throws
* @pre
* @post
public static LibrarySession getSession( HttpServletRequest request, HttpServletResponse response )
throws IfsException
if( DEBUG )
Alert.log( "getSession(request,response): Entering Method." );
dumpServletParameters( request );
// setupServletPath(request);
LibrarySession ifsSession = null;
HttpSession httpSession = request.getSession( true );
if( null != httpSession )
IfsHttpLogin ifsLogin = ( IfsHttpLogin ) httpSession.getValue( IFSHTTPLOGIN );
if( ifsLogin != null )
ifsSession = ifsLogin.getSession();
if( null == ifsSession )
try
// String timeoutPath = generateURL(request,getTimeOutURL());
String timeoutPath = HttpUtils.getURLFromIfsPath( request, getTimeOutURL() );
if( DEBUG )
Alert.log( "getSession(request,response): Unable to get a valid Session = assuming Timeout problem. Redirecting to " + timeoutPath );
response.sendRedirect( timeoutPath );
catch( IOException ioe )
throw new IfsException( 9999, ioe );
return ifsSession;
* Please complete the missing tags for getObject
* @param
* @return
* @throws
* @pre
* @post
public static PublicObject getObject( HttpServletRequest request, HttpServletResponse response )
throws IfsException
// Will return null and set a Redirect to the Timeout Page if the Sesssion
// is null.
String path = null;
PublicObject po = null;
LibrarySession ifsSession = getSession( request, response );
if( null != ifsSession )
// path = getReposPath(request);
path = HttpUtils.getIfsPathFromJSPRedirect( request );
if( path.charAt( 1 ) == ':' )
Long docId = new Long( path.substring( 2 ) );
po = ifsSession.getPublicObject( docId );
else
FolderPathResolver fpr = new FolderPathResolver( ifsSession );
fpr.setRootFolder();
po = fpr.findPublicObjectByPath( path );
if( DEBUG )
Alert.log( "getObject(request,response): Object is a " + po.getClassname() );
po = po.getResolvedPublicObject();
return po;
* Please complete the missing tags for getExtendedAttributeValues
* @param
* @return
* @throws
* @pre
* @post
public static LibraryObjectDefinition getExtendedAttributeValues( LibraryObject lo, HttpServletRequest request )
throws IfsException
// Returns a Library Object Definition containing the Attribute Values for each
// Extended Attribute which appears as a parameter in the request obvject.
ClassObject co = lo.getClassObject();
Attribute [] attributes = co.getExtendedClassAttributes();
return getAttributeValues( attributes, request );
* Please complete the missing tags for getEffectiveAttributeValues
* @param
* @return
* @throws
* @pre
* @post
public static LibraryObjectDefinition getEffectiveAttributeValues( LibraryObject lo, HttpServletRequest request )
throws IfsException
// Returns a Library Object Definition containing the Attribute Values for each
// Extended Attribute which appears as a parameter in the request obvject.
ClassObject co = lo.getClassObject();
Attribute [] attributes = co.getEffectiveClassAttributes();
return getAttributeValues( attributes, request );
* Please complete the missing tags for getAttributeValues
* @param
* @return
* @throws
* @pre
* @post
public static LibraryObjectDefinition getAttributeValues( Attribute [] attributes, HttpServletRequest request )
throws IfsException
LibraryObjectDefinition def = new LibraryObjectDefinition();
if( attributes != null )
for( int i = 0; i < attributes.length; i++ )
AttributeValue av = getAttributeValue( attributes [ i ], request );
if( av != null )
def.setAttribute( av );
return def;
* Please complete the missing tags for getAttributeValue
* @param
* @return
* @throws
* @pre
* @post
public static AttributeValue getAttributeValue( Attribute attribute, HttpServl etRequest request )
throws IfsException
AttributeValue av = null;
String name = attribute.getName();
String newValue = request.getParameter( name );
if( newValue != null )
if( newValue.equals( "" ) )
av = AttributeValue.newNullAttributeValue( attribute.getDataType() );
else
av = AttributeValue.newAttributeValue( newValue );
av.setName( name );
return av;
* Please complete the missing tags for downloadContent
* @param
* @return
* @throws
* @pre
* @post
public static void downloadContent( HttpServletRequest request, HttpServletResponse response )
throws IfsException
boolean download = false;
String action = request.getParameter( ACTION );
if( action != null )
if( action.equals( DOWNLOAD ) )
download = true;
Alert.log( "JspHelper.downloadContent(): download = " + download );
try
Document doc = ( Document ) JspHelper.getObject( request, response );
OutputStream os = response.getOutputStream();
if( download )
response.setContentType( OPEN_SAVEAS_DIALOG );
response.setHeader( "Content-Disposition", "attachment; filename=" + doc.getName() );
else
response.setContentType( doc.getFormat().getMimeType() );
response.setHeader( "Content-Disposition", "inline; filename=" + doc.getName() );
response.setContentLength( ( int ) doc.getContentSize() );
InputStream is = doc.getContentStream();
byte [] bytesRead = new byte [ 1024 ];
for( int byteCount = is.read( bytesRead, 0, bytesRead.length );
byteCount > 0;
byteCount = is.read( bytesRead, 0, bytesRead.length ) )
os.write( bytesRead, 0, byteCount );
catch( Exception e )
throw new IfsException( 9999, e );
* Please complete the missing tags for dumpServletParameters
* @param
* @return
* @throws
* @pre
* @post
public static void dumpServletParameters( HttpServletRequest request )
// setupServletPath(request);
Enumeration parmList = request.getParameterNames();
Alert.log( "Parameter List:" );
while( parmList.hasMoreElements() )
String parmName = ( String ) parmList.nextElement();
Alert.log( " " + parmName );
Alert.log( "Parameter Processing Completed." );
* Please complete the missing tags for obtainSession
* @param
* @return
* @throws
* @pre
* @post
public static LibrarySession obtainSession( HttpServletRequest request, HttpServletResponse response )
throws IfsException
if( DEBUG )
Alert.log( "obtainSession(request,response): Servlet Parameters = " );
dumpServletParameters( request );
// setupServletPath(request);
HttpSession httpSession = request.getSession( true );
if( httpSession != null )
IfsHttpLogin ifsLogin = ( IfsHttpLogin ) httpSession.getValue( IFSHTTPLOGIN );
if( ifsLogin != null )
LibrarySession ifsSession = ifsLogin.getSession();
if( ifsSession != null )
return ifsSession;
if( DEBUG )
Alert.log( "JspHelper.obtainSession: Unable to get Session. - Attempting to create new Session" );
LibrarySession ifs = null;
String username = "guest";
String password = "welcome";
String service = "IfsDefault";
String schemaPassword = "manager";
String suppliedUsername = request.getParameter( USERNAME );
String suppliedPassword = request.getParameter( PASSWORD );
String suppliedService = request.getParameter( SERVICE );
String suppliedSchemaPassword = request.getParameter( SCHEMA_PASSWORD );
if( suppliedUsername != null )
username = suppliedUsername;
if( suppliedPassword != null )
password = suppliedUsername;
if( suppliedService != null )
service = suppliedService;
if( suppliedSchemaPassword != null )
schemaPassword = suppliedSchemaPassword;
if( DEBUG )
Alert.log( "JspHelper.obtainSession: Creating new Session." );
Alert.log( " Username = " + username );
Alert.log( " Password = " + password );
Alert.log( " Service = " + service );
Alert.log( " Schema Password = " + schemaPassword );
LibraryService ifsService = new LibraryService();
CleartextCredential me = new CleartextCredential( username, password );
ConnectOptions connect = new ConnectOptions();
connect.setLocale( Locale.getDefault() );
connect.setServiceName( service );
connect.setServicePassword( schemaPassword );
LibrarySession ifsSession = ifsService.connect( me, connect );
if( DEBUG )
Alert.log( "JspHelper.obtainSession: Session Created." );
JspLogin login = new JspLogin();
login.setSession( ifsSession );
httpSession.putValue( IFSHTTPLOGIN, login );
if( DEBUG )
Alert.log( "JspHelper.obtainSession: Login Object Saved." );
return ifsSession;
* Please complete the missing tags for replaceString
* @param
* @return
* @throws
* @pre
* @post
public static String replaceString( String string, String string1, String string2 )
int offset = string.indexOf( string1 );
switch( offset )
case - 1 :
return string;
case 0 :
return string2 + replaceString( string.substring( string1.length() ), string1, string2 );
default:
return string.substring( 0, offset ) + string2 + replaceString( string.substring( offset + string1.length() ), string1, string2 );
* Please complete the missing tags for printLink
* @param
* @return
* @throws
* @pre
* @post
public static void printLink( javax.servlet.jsp.JspWriter out,
String name,
String url,
String color )
throws java.io.IOException
if( null != url )
if( url.indexOf( "http://" ) != 0 )
url = "http://" + url;
out.println( "<BR><A HREF=\"" + url + "\"><FONT COLOR=\"" + color + "\"><B>" + name + "</B></FONT></A>" );
* Please complete the missing tags for printItem
* @param
* @return
* @throws
* @pre
* @post
public static void printItem( javax.servlet.jsp.JspWriter out,
String titleValue,
String dataValue,
String titleColor,
String dataColor )
throws java.io.IOException
if( null != dataValue )
out.println( "<FONT COLOR=\"" + titleColor + "\">" + titleValue + ": </FONT> <FONT COLOR=\"" + dataColor + "\"><B>" + dataValue + "</B></FONT><BR>" );
* Please complete the missing tags for printItem
* @param
* @return
* @throws
* @pre
* @post
public static void printItem( javax.servlet.jsp.JspWriter out,
String titleValue,
Integer dataValue,
String titleColor,
String dataColor )
throws java.io.IOException
if( null != dataValue )
printItem( out, titleValue, dataValue.toString(), titleColor, dataColor );
* Please complete the missing tags for printItem
* @param
* @return
* @throws
* @pre
* @post
public static void printItem( javax.servlet.jsp.JspWriter out,
String titleValue,
Boolean dataValue,
String titleColor,
String dataColor )
throws java.io.IOException
if( null != dataValue )
printItem( out, titleValue, dataValue.toString(), titleColor, dataColor );
* Please complete the missing tags for printItem
* @param
* @return
* @throws
* @pre
* @post
public static void printItem( javax.servlet.jsp.JspWriter out,
String titleValue,
Date dataValue,
String titleColor,
String dataColor )
throws java.io.IOException
if( null != dataValue )
printItem( out, titleValue, dataValue.toString(), titleColor, dataColor );
* Please complete the missing tags for renderContent
* @param
* @return
* @throws
* @pre
* @post
public static void renderContent( HttpServletRequest request, HttpServletResponse response )
throws IfsException
Document doc = ( Document ) JspHelper.getObject( request, response );
boolean download = false;
boolean renderedOutput = false;
String mimeType = null;
// Determine if we are opening or Downloading Content based on Action
String action = request.getParameter( ACTION );
if( action != null )
if( action.equals( DOWNLOAD ) )
download = true;
if( DEBUG )
Aler t.log( "JspHelper.downloadContent(): download = " + download );
// Determine is we want Raw or Rendered Content. For Rendered Content both
// Operation and Policy must be supplied.
String operation = request.getParameter( OPERATION );
String policy = request.getParameter( POLICY );
if( ( null != operation ) && ( null != policy ) )
renderedOutput = true;
if( DEBUG )
Alert.log( "JspHelper.downloadContent(): renderedOutput = " + renderedOutput );
// Determine if contentType comes from Document or is supplied explicity.
mimeType = request.getParameter( MIMETYPE );
if( null == mimeType )
mimeType = doc.getFormat().getMimeType();
if( DEBUG )
Alert.log( "JspHelper.downloadContent(): mimeType = " + mimeType );
// Process as Requested.
try
response.setContentType( mimeType );
String filename = doc.getName();
String fileExtension = filename.substring( filename.lastIndexOf( '.' ) + 1 );
filename = filename.substring( 0, filename.lastIndexOf( '.' ) - 1 );
Selector mySelector = new Selector( getSession( request, response ) );
mySelector.setSearchClassname( Format.CLASS_NAME );
mySelector.setSearchSelection( Format.MIMETYPE_ATTRIBUTE + "='" + mimeType + "'" );
if( mySelector.getItemCount() > 0 )
Format f = ( Format ) mySelector.getItems( 0 );
fileExtension = f.getExtension();
filename = filename + '.' + fileExtension;
if( DEBUG )
Alert.log( "JspHelper.RenderContent(): Filename = " + filename );
if( download )
response.setHeader( "Content-Disposition", "attachment; filename=" + filename );
else
response.setHeader( "Content-Disposition", "inline; filename=" + filename );
InputStream is;
if( renderedOutput )
is = doc.renderAsStream( operation, policy, null );
else
is = doc.getContentStream();
response.setContentLength( ( int ) doc.getContentSize() );
OutputStream os = response.getOutputStream();
byte [] bytesRead = new byte [ 1024 ];
for( int byteCount = is.read( bytesRead, 0, bytesRead.length );
byteCount > 0;
byteCount = is.read( bytesRead, 0, bytesRead.length ) )
os.write( bytesRead, 0, byteCount );
catch( Exception e )
throw new IfsException( 9999, e );
* Please complete the missing tags for dumpInputStream
* @param
* @return
* @throws
* @pre
* @post
public static void dumpInputStream( ServletInputStream sis )
throws IOException
FileOutputStream fos;
if( File.separator.equals( "\\" ) )
fos = new FileOutputStream( "C:\\temp\\request.txt" );
else
fos = new FileOutputStream( "/tmp/request.txt" );
byte [] bytes = new byte [ 1024 ];
for( int bytesRead = sis.readLine( bytes, 0, bytes.length );
bytesRead > 0;
bytesRead = sis.read( bytes, 0, bytes.length ) )
Alert.log( "JspHelper.dumpInputStream() BytesRead = " + bytesRead );
fos.write( bytes, 0, bytesRead );
fos.close();
* Please complete the missing tags for getTimeOutURL
* @param
* @return
* @throws
* @pre
* @post
private static String getTimeOutURL()
Locale locale = Locale.getDefault();
String country = locale.getCountry();
String language = locale.getLanguage().toLowerCase();
String localizedFolder = language;
if( country != null )
if( ( ! language.equalsIgnoreCase( "en" ) ) &#0124; &#0124;
( ( language.equalsIgnoreCase( "en" ) ) && ( ! country.equalsIgnoreCase( "US" ) ) ) )
language = language + "_" + country.toUpperCase();
return IFSWEBROOT + "/" + language + IFSTIMEOUT_URL;
null