Prev

Chapter10.DSpaceSystemDocumentation:DirectoriesandFiles

Next

Chapter10.DSpaceSystemDocumentation:Directoriesand Files
TableofContents 10.1.Overview 10.2.SourceDirectoryLayout 10.3.InstalledDirectoryLayout 10.4.ContentsofJSPUIWebApplication 10.5.ContentsofXMLUIWebApplication(akaManakin) 10.6.LogFiles 10.6.1.log4j.propertiesFile.

10.1.Overview
AcompleteDSpaceinstallationconsistsofthreeseparatedirectorytrees: Thesourcedirectory: Thisiswhere(surprise!)thesourcecodelives.Notethattheconfigfileshereareusedonlyduring theinitialinstallprocess.Aftertheinstall,configfilesshouldbechangedintheinstalldirectory.It isreferredtointhisdocumentas[ d s p a c e s o u r c e ] . Theinstalldirectory: ThisdirectoryispopulatedduringtheinstallprocessandalsobyDSpaceasitruns.Itcontains configfiles,commandlinetools(andthelibrariesnecessarytorunthem),andusuallyalthough notnecessarilythecontentsoftheDSpacearchive(dependingonhowDSpaceisconfigured). Aftertheinitialbuildandinstall,changestoconfigfilesshouldbemadeinthisdirectory.Itis referredtointhisdocumentas[ d s p a c e ] . Thewebdeploymentdirectory: Thisdirectoryisgeneratedbythewebserverthefirsttimeitfindsadspace.warfileinitswebapps directory.Itcontainstheunpackedcontentsofdspace.war,i.e.theJSPsandjavaclassesand librariesnecessarytorunDSpace.Filesinthisdirectoryshouldneverbeediteddirectlyifyou wishtomodifyyourDSpaceinstallation,youshouldeditfilesinthesourcedirectoryandthen rebuild.Thecontentsofthisdirectoryaren'tlistedheresinceitscreationiscompletelyautomatic.It isusuallyreferredtointhisdocumentas[ t o m c a t ] / w e b a p p s / d s p a c e .

10.2.SourceDirectoryLayout
[ d s p a c e s o u r c e ]

d s p a c e / DirectorywhichcontainsallbuildandconfigurationinformationforDSpace C H A N G E S Detailedlistofcodechangesbetweenversions. K N O W N _ B U G S Knownbugsinthecurrentversion. L I C E N S E DSpacesourcecodelicense. R E A D M E Obligatorybasicinformationfile. b i n / SomeshellandPerlscriptsforrunningDSpacecommandlinetasks. c o n f i g / Configurationfiles: c o n t r o l l e d v o c a b u l a r i e s / Fixed,limitedvocabulariesusedinmetadata

entry
c r o s s w a l k s / MetadatacrosswalkspropertyfilesorXSLstylesheets d s p a c e . c f g TheMainDSpaceconfigurationfile(Youwillneedtoeditthis). d c 2 m o d s . c f g MappingsfromDublinCoremetadatatoMODSfortheMETS

export.
d e f a u l t . l i c e n s e Thedefaultlicensethatusersmustgrantwhensubmitting

items.
d s t a t . c f g ,d s t a t . m a p Configurationforstatisticalreports. i n p u t f o r m s . x m l SubmissionUImetadatafieldconfiguration. n e w s s i d e . h t m l Textofthefrontpagenewsinthesidebar,onlyusedin

JSPUI.
n e w s t o p . h t m l Textofthefrontpagenewsinthetopbox,onlyusedinteh

JSPUI.
e m a i l s / Textandlayouttemplatesforemailssentoutbythesystem. r e g i s t r i e s / InitialcontentsofthebitstreamformatregistryandDublin

Coreelement/qualifierregistry.Theseareonlyusedoninitialsystemsetup, afterwhichtheyaremaintainedinthedatabase.
d o c s / DSpacesystemdocumentation.Thetechnicaldocumentationfor

functionality,installation,configuration,etc.
e t c / Thisdirectorycontainsadministrativefilesneededfortheinstallprocessand

bydevelopers,mostlydatabaseinitializationandupgradescripts.Any. x m l filesin e t c / arecommontoallsupporteddatabasesystems.

p o s t g r e s / VersionsofthedatabaseschemaandupdaterSQLscriptsfor

PostgreSQL.

o r a c l e / VersionsofthedatabaseschemaandupdaterSQLscriptsforOracle. m o d u l e s / TheWebUImodules"overlay"directory.DSpaceusesMavento

automaticallylookhereforanycustomizationsyouwishtomaketoDSpaceWeb interfaces.
j s p u i ContainsallcustomizationsfortheJSPUserInterface. s r c / m a i n / r e s o u r c e s / TheoverlayforJSPUIResources.Thisisthe

locationtoplaceanycustomMessages.propertiesfiles.(Previouslythis filehadbeenstoredat:[ d s p a c e s o u r c e ] / c o n f i g / l a n g u a g e p a c k s / M e s s a g e s . p r o p e r t i e s s r c / m a i n / w e b a p p / TheoverlayforJSPUIWebApplication.Thisis

thelocationtoplaceanycustomJSPstobeusedbyDSpace.
l n i ContainsallcustomizationsfortheLightweightNetworkInterface. o a i ContainsallcustomizationsfortheOAIPMHInterface. s w o r d ContainsallcustomizationsfortheSWORD(SimpleWebservice

OfferingRepositoryDeposit)Interface.
x m l u i ContainsallcustomizationsfortheXMLUserInterface(akaManakin). s r c / m a i n / w e b a p p / TheoverlayforXMLUIWebApplication.Thisis

thelocationtoplacecustomThemesorConfigurations.
i 1 8 n / ThelocationtoplaceacustomversionoftheXMLUI's

messages.xml(Youhavetomanuallycreatethisfolder)
t h e m e s / ThelocationtoplacecustomThemesfortheXMLUI

(Youhavetomanuallycreatethisfolder).
s r c / MavenconfigurationsforDSpaceSystem.ThisdirectorycontainstheMaven

andAntbuildfilesforDSpace.
t a r g e t / (OnlyexistsafterbuildingDSpace)ThisisthelocationMavenusesto

buildyourDSpaceinstallationpackage.
d s p a c e [ v e r s i o n ] . d i r ThelocationoftheDSpaceInstallationPackage

(whichcanthenbeinstalledbyrunninga n tu p d a t e )

10.3.InstalledDirectoryLayout
BelowisthebasiclayoutofaDSpaceinstallationusingthedefaultconfiguration.Thesepathscanbe configuredifnecessary.
[ d s p a c e ] a s s e t s t o r e / assetstorefiles

b i n / shellandPerlscripts c o n f i g / configuration,withsubdirectoriesasabove h a n d l e s e r v e r / Handlesserverfiles h i s t o r y / storedhistoryfiles(generallyRDF/XML) l i b / JARs,includingdspace.jar,containingtheDSpaceclasses l o g / Logfiles r e p o r t s / Reportsgeneratedbystatisticalreportgenerator s e a r c h / Lucenesearchindexfiles u p l o a d / temporarydirectoryusedduringfileuploadsetc. w e b a p p s / locationwhereDSpaceinstallsallWebApplications

10.4.ContentsofJSPUIWebApplication
DSpace'sAntbuildfilecreatesad s p a c e j s p u i w e b a p p / directorywiththefollowingstructure: (topleveldir) TheJSPs
W E B I N F / w e b . x m l DSpaceJSPUIWebApplicationconfigurationandServletmappings d s p a c e t a g s . t l d DSpacecustomtagdescriptor f m t . t l d JSTLmessageformattagdescriptor,forinternationalization l i b / AllthethirdpartyJARsandprecompiledDSpaceAPIJARsneededtorun

JSPUI
c l a s s e s / Anyadditionalnecessaryclassfiles

10.5.ContentsofXMLUIWebApplication(akaManakin)
DSpace'sAntbuildfilecreatesad s p a c e x m l u i w e b a p p / directorywiththefollowingstructure: (topleveldir)
a s p e c t s / ContainsoverarchingAspectGeneratorconfigandPrototypeDRI(Digital

RepositoryInterface)documentforManakin.
i 1 8 n / Internationalization/Multilingualsupport.Containsthem e s s a g e s . x m l English

languagepackbydefault.
t h e m e s / ContainsalloutoftheboxManakinthemes C l a s s i c / Theclassictheme,whichmakestheXMLUIlooklikeclassicDSpace d r i 2 x h t m l / Thebasetheme,whichconvertsXMLUIDRI(DigitalRepository

Interface)formatintoXHTMLfordisplay
R e f e r e n c e / ThedefaultreferencethemeforXMLUI t e m p l a t e / Athemetemplate...usefulasastartingpointforyourowncustom

theme(s)
d r i 2 x h t m l . x s l TheDRItoXHTMLXSLStylesheet.Usestheabove'dri2xhtml'

themetogenerateXHTML
t h e m e s . x m a p TheThemeconfigurationfile.Itdetermineswhichtheme(s)areused

byXMLUI
W E B I N F / l i b / AllthethirdpartyJARsandprecompiledDSpaceJARsneededtorun

XMLUI
c l a s s e s / Anyadditionalnecessaryclassfiles c o c o o n . x c o n f XMLUI'sApacheCocoonconfiguration l o g k i t . x c o n f XMLUI'sApacheCocoonLoggingconfiguration w e b . x m l XMLUIWebApplicationconfigurationandServletmappings

10.6.LogFiles
Thefirstsourceofpotentialconfusionisthelogfiles.SinceDSpaceusesanumberofthirdpartytools, problemscanoccurinavarietyofplaces.Belowisatablelistingthemainlogfilesusedinatypical DSpacesetup.Thelocationsgivenaredefaults,andmightbedifferentforyoursystemdependingon whereyouinstalledDSpaceandthethirdpartytools.Theorderingofthelistisroughlythe recommendedorderforsearchingthemforthedetailsaboutaparticularproblemorerror. Table10.1.DSpaceLogFileLocations LogFile What'sInIt MainDSpacelogfile.ThisiswheretheDSpacecodewrites asimplelogofeventsanderrorsthatoccurwithintheDSpace code.Youcancontroltheverbosityofthisbyeditingthe
[ d s p a c e s o u r c e ] / c o n f i g / t e m p l a t e s / l o g 4 j . p r o p e r t i e s fileand

[ d s p a c e ] / l o g / d s p a c e . l o g

thenrunning"a n ti n i t _ c o n f i g s ".

[ t o m c a t ] / l o g s / c a t a l i n a . o u t

ThisiswhereTomcat'sstandardoutputiswritten.Many errorsthatoccurwithintheTomcatcodeareloggedhere.For example,ifTomcatcan'tfindtheDSpacecode (d s p a c e . j a r ),itwouldbeloggedinc a t a l i n a . o u t .

Ifyou'rerunningTomcatstandalone(withoutApache),it [ t o m c a t ] / l o g s / h o s t n a m e _ l o g . y y y y - logssomeinformationanderrorsforspecificWeb m m d d . t x t applicationstothislogfile.h o s t n a m e willbeyourhostname (e.g.d s p a c e . m y u . e d u )andy y y y m m d d willbethedate.

[ t o m c a t ] / l o g s / a p a c h e _ l o g . y y y y m m d d . t x t

Ifyou'reusingApache,TomcatlogsinformationaboutWeb applicationsrunningthroughApache(m o d _ w e b a p p )inthis logfile(y y y y m m d d beingthedate.) Apachelogstothisfile.Ifthereisaproblemwithgetting m o d _ w e b a p p working,thisisagoodplacetolookforclues. Apachealsowritestoseveralotherlogfiles,though e r r o r _ l o g tendstocontainthemostusefulinformationfor trackingdownproblems. TheHandleserverrunsasaseparateprocessfromthe DSpaceWebUI(whichrunsunderTomcat'sJVM).Duetoa limitationoflog4j's'rollingfileappenders',theDSpacecode runningintheHandleserver'sJVMmustuseaseparatelog file.TheDSpacecodethatisrunaspartofaHandle resolutionrequestwritesloginformationtothisfile.Youcan controltheverbosityofthisbyediting[ d s p a c e s o u r c e ] / c o n f i g / t e m p l a t e s / l o g 4 j h a n d l e p l u g i n . p r o p e r t i e s .

[ a p a c h e ] / e r r o r _ l o g

[ d s p a c e ] / l o g / h a n d l e p l u g . l o g

[ d s p a c e ] / l o g / h a n d l e s e r v e r . l o g

ThisisthelogfileforCNRI'sHandleservercode.Ifa problemoccurswithintheHandleservercode,before DSpace'spluginisinvoked,thisiswhereitmaybelogged. Ontheotherhand,aproblemwithCNRI'sHandleserver codemightbeloggedhere. PostgreSQLalsowritesalogfile.Thisonedoesn'tseemto haveadefaultlocation,youprobablyhadtospecifyit yourselfatsomepointduringinstallation.Ingeneral,thislog filerarelycontainspertinentinformationPostgreSQLis prettystable,you'remorelikelytoencounterproblemswith connectingviaJDBC,andtheseproblemswillbeloggedin d s p a c e . l o g .

[ d s p a c e ] / h a n d l e s e r v e r / e r r o r . l o g

P o s t g r e S Q Ll o g

10.6.1.log4j.propertiesFile.
thefile[ d s p a c e ] / c o n f i g / l o g 4 j . p r o p e r t i e s controlshowandwherelogfilesarecreated.Thereare threesetsofconfigurationsinthatfile,calledA1,A2,andA3.Theseareusedtocontrolthelogsfor DSpace,thechecksumchecker,andtheXMLUIrespectively.Theimportantsettingsinthisfileare: Table10.2.log4j.propertiesTable

l o g 4 j . r o o t C a t e g o r y = I N F O , A l o g 4 j . l o g g e r . o r g . d s p a c e = I N F O , A 1

Theselinescontrolwhatlevelof loggingtakesplace.Normally theyshouldbesettoINFO,but ifyouneedtoseemore informationinthelogs,setthem todEBUGandrestartyourweb server

Thisisthenameofthelogfile creationmethodused.The l o g 4 j . a p p e n d e r . A 1 = o r g . d s p a c e . a p p . u t i l . D a i l y F i l e A p p e n d e r DailyFileAppendercreatesa newdatestampedfileeveryday ormonth.

l o g 4 j . a p p e n d e r . A 1 . F i l e = $ { l o g . d i r } / d s p a c e . l o g

Thissetsthefilenameand locationofwherethelogfile willbestored.Itiwllhaveadate stampappendedtothefilename. Thisdefinestheformatforthe datestampthatisappendedto thelogfilenames.Ifyouwishto havelogfilescreatedmonthyl insteadofdaily,changethisto

y y y y M M

l o g 4 j . a p p e n d e r . A 1 . D a t e P a t t e r n = y y y M M D D

l o g 4 j . a p p e n d e r . A 1 . M a x L o g s = 0

Thisdefineshowmanylogfiles willbecreated.Youmaywish todefinearetentionperiodfor logfiles.Ifyousetthisto365, logsolderthanayearwillbe deleted.Bydefaultthisissetto 0sothatnologsareever deleted.Ensurethatyoumonitor thediskspaceusedbythelogs tomakesurethatyouhave enoughspaceforthem.Itis oftenimportanttokeepthelog filesforalongtimeincaseyou wanttorebuildyourstatistics.

Copyright20022010DuraSpace

LicensedunderaCreativeCommonsAttribution3.0UnitedStatesLicense Prev Next

Chapter9.DSpaceSystem Documentation:StorageLayer

Home

Chapter11.DSpaceSystem Documentation:Architecture