01: /*
02: * ChainBuilder ESB
03: * Visual Enterprise Integration
04: *
05: * Copyright (C) 2006 Bostech Corporation
06: *
07: * This program is free software; you can redistribute it and/or modify
08: * it under the terms of the GNU General Public License as published by
09: * the Free Software Foundation; either version 2 of the License, or
10: * (at your option) any later version.
11: *
12: * This program is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * General Public License for more details.
16: *
17: * You should have received a copy of the GNU General Public License
18: * along with this program; if not, write to the Free Software
19: * Foundation, Inc.,59 Temple Place, Suite 330, Boston, MA 02111-1307
20: * USA
21: *
22: * $Id: IDocLocationResolver.java 5952 2007-03-14 02:25:52Z mpreston $
23: *
24: */
25: package com.bostechcorp.cbesb.common.mdl;
26:
27: import org.xml.sax.InputSource;
28:
29: /**
30: * Provides a method used by MDLDocumentFactory to resolve the locations of
31: * referenced MDL files. This will mainly be used in the JBI Components that use
32: * the Parser or Serializer to be able to provide a dynamic location of the MDL
33: * files in the Service Unit or Service Assembly.
34: *
35: */
36: public interface IDocLocationResolver {
37:
38: /**
39: * Method used to resolve a new InputSource for the MDL document referenced
40: * by a format specification. The format specification is usually of the form:
41: * projName::src/formats/foldername/def.mdl:messageName
42: * with some variations for specialized formats. This method should
43: * return an InputSource for the MDL document defining the specified message.
44: * @param formatSpec
45: * @return
46: */
47: public InputSource resolveFormatSpec(String formatSpec)
48: throws MDLException;
49:
50: /**
51: * Method used to return a new InputSource for the MDL document referenced
52: * by docLocation. The currentWorkingDir parameter may be used as a clue
53: * to resolve relative paths in docLocation.
54: * @param docLocation The location of the MDL file to load. This may be an
55: * absolute path or relative path.
56: * @param currentWorkingDir The path to use as the current working directory.
57: * @return a parsable InputSource that references the MDL document.
58: */
59: public InputSource resolveDocLocation(String docLocation,
60: String currentWorkingDir) throws MDLException;
61:
62: /**
63: * Method to assign a unique identifier to an MDL document to access
64: * it from the cache. This could be the absolute path to the MDL file,
65: * or a combination of variant name and message or segment name or any
66: * other unique identifier.
67: * @param docLocation
68: * @param currentWorkingDirectory
69: * @return
70: */
71: public String getCacheIDFromDocLocation(String docLocation,
72: String currentWorkingDirectory) throws MDLException;
73:
74: /**
75: * Method to assign a unique identifier to an MDL document to access
76: * it from the cache. This could be the absolute path to the MDL file,
77: * or a combination of variant name and message or segment name or any
78: * other unique identifier.
79: * @param formatSpec
80: * @return
81: */
82: public String getCacheIDFromFormatSpec(String formatSpec)
83: throws MDLException;
84:
85: public String getAbsolutePathFromFormatSpec(String formatSpec)
86: throws MDLException;
87:
88: public String getAbsolutePathFromDocLocation(String docLocation,
89: String currentWorkingDirectory) throws MDLException;
90:
91: }
|