diff --git a/org.springframework.samples.petclinic/build.xml b/org.springframework.samples.petclinic/build.xml new file mode 100644 index 00000000000..75ee8575f1f --- /dev/null +++ b/org.springframework.samples.petclinic/build.xml @@ -0,0 +1,5 @@ + + + + + diff --git a/org.springframework.samples.petclinic/ivy.xml b/org.springframework.samples.petclinic/ivy.xml new file mode 100644 index 00000000000..8dd6cef2e3f --- /dev/null +++ b/org.springframework.samples.petclinic/ivy.xml @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/org.springframework.samples.petclinic/petclinic.iml b/org.springframework.samples.petclinic/petclinic.iml new file mode 100644 index 00000000000..57ef73fd8d6 --- /dev/null +++ b/org.springframework.samples.petclinic/petclinic.iml @@ -0,0 +1,141 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/BaseEntity.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/BaseEntity.java new file mode 100644 index 00000000000..bb68af4fc01 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/BaseEntity.java @@ -0,0 +1,27 @@ +package org.springframework.samples.petclinic; + +/** + * Simple JavaBean domain object with an id property. + * Used as a base class for objects needing this property. + * + * @author Ken Krebs + * @author Juergen Hoeller + */ +public class BaseEntity { + + private Integer id; + + + public void setId(Integer id) { + this.id = id; + } + + public Integer getId() { + return id; + } + + public boolean isNew() { + return (this.id == null); + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Clinic.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Clinic.java new file mode 100644 index 00000000000..872bd457c29 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Clinic.java @@ -0,0 +1,77 @@ +package org.springframework.samples.petclinic; + +import java.util.Collection; + +import org.springframework.dao.DataAccessException; + +/** + * The high-level PetClinic business interface. + * + *

This is basically a data access object. + * PetClinic doesn't have a dedicated business facade. + * + * @author Ken Krebs + * @author Juergen Hoeller + * @author Sam Brannen + */ +public interface Clinic { + + /** + * Retrieve all Vets from the data store. + * @return a Collection of Vets + */ + Collection getVets() throws DataAccessException; + + /** + * Retrieve all PetTypes from the data store. + * @return a Collection of PetTypes + */ + Collection getPetTypes() throws DataAccessException; + + /** + * Retrieve Owners from the data store by last name, + * returning all owners whose last name starts with the given name. + * @param lastName Value to search for + * @return a Collection of matching Owners + * (or an empty Collection if none found) + */ + Collection findOwners(String lastName) throws DataAccessException; + + /** + * Retrieve an Owner from the data store by id. + * @param id the id to search for + * @return the Owner if found + * @throws org.springframework.dao.DataRetrievalFailureException if not found + */ + Owner loadOwner(int id) throws DataAccessException; + + /** + * Retrieve a Pet from the data store by id. + * @param id the id to search for + * @return the Pet if found + * @throws org.springframework.dao.DataRetrievalFailureException if not found + */ + Pet loadPet(int id) throws DataAccessException; + + /** + * Save an Owner to the data store, either inserting or updating it. + * @param owner the Owner to save + * @see BaseEntity#isNew + */ + void storeOwner(Owner owner) throws DataAccessException; + + /** + * Save a Pet to the data store, either inserting or updating it. + * @param pet the Pet to save + * @see BaseEntity#isNew + */ + void storePet(Pet pet) throws DataAccessException; + + /** + * Save a Visit to the data store, either inserting or updating it. + * @param visit the Visit to save + * @see BaseEntity#isNew + */ + void storeVisit(Visit visit) throws DataAccessException; + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/NamedEntity.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/NamedEntity.java new file mode 100644 index 00000000000..40c5931d86d --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/NamedEntity.java @@ -0,0 +1,28 @@ +package org.springframework.samples.petclinic; + +/** + * Simple JavaBean domain object adds a name property to BaseEntity. + * Used as a base class for objects needing these properties. + * + * @author Ken Krebs + * @author Juergen Hoeller + */ +public class NamedEntity extends BaseEntity { + + private String name; + + + public void setName(String name) { + this.name = name; + } + + public String getName() { + return this.name; + } + + @Override + public String toString() { + return this.getName(); + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Owner.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Owner.java new file mode 100644 index 00000000000..75ea3bc064c --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Owner.java @@ -0,0 +1,127 @@ +package org.springframework.samples.petclinic; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashSet; +import java.util.List; +import java.util.Set; + +import org.springframework.beans.support.MutableSortDefinition; +import org.springframework.beans.support.PropertyComparator; +import org.springframework.core.style.ToStringCreator; + +/** + * Simple JavaBean domain object representing an owner. + * + * @author Ken Krebs + * @author Juergen Hoeller + * @author Sam Brannen + */ +public class Owner extends Person { + + private String address; + + private String city; + + private String telephone; + + private Set pets; + + + public String getAddress() { + return this.address; + } + + public void setAddress(String address) { + this.address = address; + } + + public String getCity() { + return this.city; + } + + public void setCity(String city) { + this.city = city; + } + + public String getTelephone() { + return this.telephone; + } + + public void setTelephone(String telephone) { + this.telephone = telephone; + } + + protected void setPetsInternal(Set pets) { + this.pets = pets; + } + + protected Set getPetsInternal() { + if (this.pets == null) { + this.pets = new HashSet(); + } + return this.pets; + } + + public List getPets() { + List sortedPets = new ArrayList(getPetsInternal()); + PropertyComparator.sort(sortedPets, new MutableSortDefinition("name", true, true)); + return Collections.unmodifiableList(sortedPets); + } + + public void addPet(Pet pet) { + getPetsInternal().add(pet); + pet.setOwner(this); + } + + /** + * Return the Pet with the given name, or null if none found for this Owner. + * + * @param name to test + * @return true if pet name is already in use + */ + public Pet getPet(String name) { + return getPet(name, false); + } + + /** + * Return the Pet with the given name, or null if none found for this Owner. + * + * @param name to test + * @return true if pet name is already in use + */ + public Pet getPet(String name, boolean ignoreNew) { + name = name.toLowerCase(); + for (Pet pet : getPetsInternal()) { + if (!ignoreNew || !pet.isNew()) { + String compName = pet.getName(); + compName = compName.toLowerCase(); + if (compName.equals(name)) { + return pet; + } + } + } + return null; + } + + @Override + public String toString() { + return new ToStringCreator(this) + + .append("id", this.getId()) + + .append("new", this.isNew()) + + .append("lastName", this.getLastName()) + + .append("firstName", this.getFirstName()) + + .append("address", this.address) + + .append("city", this.city) + + .append("telephone", this.telephone) + + .toString(); + } +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Person.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Person.java new file mode 100644 index 00000000000..da7974a7de7 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Person.java @@ -0,0 +1,32 @@ +package org.springframework.samples.petclinic; + +/** + * Simple JavaBean domain object representing an person. + * + * @author Ken Krebs + */ +public class Person extends BaseEntity { + + private String firstName; + + private String lastName; + + public String getFirstName() { + return this.firstName; + } + + public void setFirstName(String firstName) { + this.firstName = firstName; + } + + public String getLastName() { + return this.lastName; + } + + public void setLastName(String lastName) { + this.lastName = lastName; + } + + + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Pet.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Pet.java new file mode 100644 index 00000000000..f5294b5ca9f --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Pet.java @@ -0,0 +1,77 @@ +package org.springframework.samples.petclinic; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.Date; +import java.util.HashSet; +import java.util.List; +import java.util.Set; + +import org.springframework.beans.support.MutableSortDefinition; +import org.springframework.beans.support.PropertyComparator; + +/** + * Simple JavaBean business object representing a pet. + * + * @author Ken Krebs + * @author Juergen Hoeller + * @author Sam Brannen + */ +public class Pet extends NamedEntity { + + private Date birthDate; + + private PetType type; + + private Owner owner; + + private Set visits; + + + public void setBirthDate(Date birthDate) { + this.birthDate = birthDate; + } + + public Date getBirthDate() { + return this.birthDate; + } + + public void setType(PetType type) { + this.type = type; + } + + public PetType getType() { + return this.type; + } + + protected void setOwner(Owner owner) { + this.owner = owner; + } + + public Owner getOwner() { + return this.owner; + } + + protected void setVisitsInternal(Set visits) { + this.visits = visits; + } + + protected Set getVisitsInternal() { + if (this.visits == null) { + this.visits = new HashSet(); + } + return this.visits; + } + + public List getVisits() { + List sortedVisits = new ArrayList(getVisitsInternal()); + PropertyComparator.sort(sortedVisits, new MutableSortDefinition("date", false, false)); + return Collections.unmodifiableList(sortedVisits); + } + + public void addVisit(Visit visit) { + getVisitsInternal().add(visit); + visit.setPet(this); + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/PetType.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/PetType.java new file mode 100644 index 00000000000..aaadc5c44d0 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/PetType.java @@ -0,0 +1,8 @@ +package org.springframework.samples.petclinic; + +/** + * @author Juergen Hoeller + */ +public class PetType extends NamedEntity { + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Specialty.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Specialty.java new file mode 100644 index 00000000000..d19ccaba96e --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Specialty.java @@ -0,0 +1,10 @@ +package org.springframework.samples.petclinic; + +/** + * Models a {@link Vet Vet's} specialty (for example, dentistry). + * + * @author Juergen Hoeller + */ +public class Specialty extends NamedEntity { + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Vet.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Vet.java new file mode 100644 index 00000000000..53d0b5c49f3 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Vet.java @@ -0,0 +1,49 @@ +package org.springframework.samples.petclinic; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashSet; +import java.util.List; +import java.util.Set; + +import org.springframework.beans.support.MutableSortDefinition; +import org.springframework.beans.support.PropertyComparator; + +/** + * Simple JavaBean domain object representing a veterinarian. + * + * @author Ken Krebs + * @author Juergen Hoeller + * @author Sam Brannen + */ +public class Vet extends Person { + + private Set specialties; + + + protected void setSpecialtiesInternal(Set specialties) { + this.specialties = specialties; + } + + protected Set getSpecialtiesInternal() { + if (this.specialties == null) { + this.specialties = new HashSet(); + } + return this.specialties; + } + + public List getSpecialties() { + List sortedSpecs = new ArrayList(getSpecialtiesInternal()); + PropertyComparator.sort(sortedSpecs, new MutableSortDefinition("name", true, true)); + return Collections.unmodifiableList(sortedSpecs); + } + + public int getNrOfSpecialties() { + return getSpecialtiesInternal().size(); + } + + public void addSpecialty(Specialty specialty) { + getSpecialtiesInternal().add(specialty); + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Visit.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Visit.java new file mode 100644 index 00000000000..e1eb90ab232 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/Visit.java @@ -0,0 +1,70 @@ +package org.springframework.samples.petclinic; + +import java.util.Date; + +/** + * Simple JavaBean domain object representing a visit. + * + * @author Ken Krebs + */ +public class Visit extends BaseEntity { + + /** Holds value of property date. */ + private Date date; + + /** Holds value of property description. */ + private String description; + + /** Holds value of property pet. */ + private Pet pet; + + + /** Creates a new instance of Visit for the current date */ + public Visit() { + this.date = new Date(); + } + + + /** Getter for property date. + * @return Value of property date. + */ + public Date getDate() { + return this.date; + } + + /** Setter for property date. + * @param date New value of property date. + */ + public void setDate(Date date) { + this.date = date; + } + + /** Getter for property description. + * @return Value of property description. + */ + public String getDescription() { + return this.description; + } + + /** Setter for property description. + * @param description New value of property description. + */ + public void setDescription(String description) { + this.description = description; + } + + /** Getter for property pet. + * @return Value of property pet. + */ + public Pet getPet() { + return this.pet; + } + + /** Setter for property pet. + * @param pet New value of property pet. + */ + protected void setPet(Pet pet) { + this.pet = pet; + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/aspects/AbstractTraceAspect.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/aspects/AbstractTraceAspect.java new file mode 100644 index 00000000000..26d32359fc4 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/aspects/AbstractTraceAspect.java @@ -0,0 +1,31 @@ +package org.springframework.samples.petclinic.aspects; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.aspectj.lang.JoinPoint; +import org.aspectj.lang.annotation.Aspect; +import org.aspectj.lang.annotation.Before; +import org.aspectj.lang.annotation.Pointcut; + +/** + * Aspect to illustrate Spring-driven load-time weaving. + * + * @author Ramnivas Laddad + * @since 2.5 + */ +@Aspect +public abstract class AbstractTraceAspect { + + private static final Log logger = LogFactory.getLog(AbstractTraceAspect.class); + + @Pointcut + public abstract void traced(); + + @Before("traced()") + public void trace(JoinPoint.StaticPart jpsp) { + if (logger.isTraceEnabled()) { + logger.trace("Entering " + jpsp.getSignature().toLongString()); + } + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/aspects/CallMonitoringAspect.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/aspects/CallMonitoringAspect.java new file mode 100644 index 00000000000..2de4cb41d0a --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/aspects/CallMonitoringAspect.java @@ -0,0 +1,81 @@ +package org.springframework.samples.petclinic.aspects; + +import org.aspectj.lang.ProceedingJoinPoint; +import org.aspectj.lang.annotation.Around; +import org.aspectj.lang.annotation.Aspect; + +import org.springframework.jmx.export.annotation.ManagedAttribute; +import org.springframework.jmx.export.annotation.ManagedOperation; +import org.springframework.jmx.export.annotation.ManagedResource; +import org.springframework.util.StopWatch; + +/** + * Simple AspectJ aspect that monitors call count and call invocation time. + * Implements the CallMonitor management interface. + * + * @author Rob Harrop + * @author Juergen Hoeller + * @since 2.5 + */ +@ManagedResource("petclinic:type=CallMonitor") +@Aspect +public class CallMonitoringAspect { + + private boolean isEnabled = true; + + private int callCount = 0; + + private long accumulatedCallTime = 0; + + + @ManagedAttribute + public void setEnabled(boolean enabled) { + isEnabled = enabled; + } + + @ManagedAttribute + public boolean isEnabled() { + return isEnabled; + } + + @ManagedOperation + public void reset() { + this.callCount = 0; + this.accumulatedCallTime = 0; + } + + @ManagedAttribute + public int getCallCount() { + return callCount; + } + + @ManagedAttribute + public long getCallTime() { + return (this.callCount > 0 ? this.accumulatedCallTime / this.callCount : 0); + } + + + @Around("within(@org.springframework.stereotype.Service *)") + public Object invoke(ProceedingJoinPoint joinPoint) throws Throwable { + if (this.isEnabled) { + StopWatch sw = new StopWatch(joinPoint.toShortString()); + + sw.start("invoke"); + try { + return joinPoint.proceed(); + } + finally { + sw.stop(); + synchronized (this) { + this.callCount++; + this.accumulatedCallTime += sw.getTotalTimeMillis(); + } + } + } + + else { + return joinPoint.proceed(); + } + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/aspects/UsageLogAspect.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/aspects/UsageLogAspect.java new file mode 100644 index 00000000000..e326abfb755 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/aspects/UsageLogAspect.java @@ -0,0 +1,48 @@ +package org.springframework.samples.petclinic.aspects; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; + +import org.aspectj.lang.annotation.Aspect; +import org.aspectj.lang.annotation.Before; + +/** + * Sample AspectJ annotation-style aspect that saves + * every owner name requested to the clinic. + * + * @author Rod Johnson + * @author Juergen Hoeller + * @since 2.0 + */ +@Aspect +public class UsageLogAspect { + + private int historySize = 100; + + // Of course saving all names is not suitable for + // production use, but this is a simple example. + private List namesRequested = new ArrayList(this.historySize); + + + public synchronized void setHistorySize(int historySize) { + this.historySize = historySize; + this.namesRequested = new ArrayList(historySize); + } + + @Before("execution(* *.findOwners(String)) && args(name)") + public synchronized void logNameRequest(String name) { + // Not the most efficient implementation, + // but we're aiming to illustrate the power of + // @AspectJ AOP, not write perfect code here :-) + if (this.namesRequested.size() > this.historySize) { + this.namesRequested.remove(0); + } + this.namesRequested.add(name); + } + + public synchronized List getNamesRequested() { + return Collections.unmodifiableList(this.namesRequested); + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/hibernate/HibernateClinic.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/hibernate/HibernateClinic.java new file mode 100644 index 00000000000..89eda8522cf --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/hibernate/HibernateClinic.java @@ -0,0 +1,89 @@ +package org.springframework.samples.petclinic.hibernate; + +import java.util.Collection; + +import org.hibernate.SessionFactory; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.samples.petclinic.Clinic; +import org.springframework.samples.petclinic.Owner; +import org.springframework.samples.petclinic.Pet; +import org.springframework.samples.petclinic.PetType; +import org.springframework.samples.petclinic.Vet; +import org.springframework.samples.petclinic.Visit; +import org.springframework.stereotype.Repository; +import org.springframework.transaction.annotation.Transactional; + +/** + * Hibernate implementation of the Clinic interface. + * + *

The mappings are defined in "petclinic.hbm.xml", located in the root of the + * class path. + * + *

Note that transactions are declared with annotations and that some methods + * contain "readOnly = true" which is an optimization that is particularly + * valuable when using Hibernate (to suppress unnecessary flush attempts for + * read-only operations). + * + * @author Juergen Hoeller + * @author Sam Brannen + * @author Mark Fisher + * @since 19.10.2003 + */ +@Repository +@Transactional +public class HibernateClinic implements Clinic { + + @Autowired + private SessionFactory sessionFactory; + + + @Transactional(readOnly = true) + @SuppressWarnings("unchecked") + public Collection getVets() { + return sessionFactory.getCurrentSession().createQuery("from Vet vet order by vet.lastName, vet.firstName").list(); + } + + @Transactional(readOnly = true) + @SuppressWarnings("unchecked") + public Collection getPetTypes() { + return sessionFactory.getCurrentSession().createQuery("from PetType type order by type.name").list(); + } + + @Transactional(readOnly = true) + @SuppressWarnings("unchecked") + public Collection findOwners(String lastName) { + return sessionFactory.getCurrentSession().createQuery("from Owner owner where owner.lastName like :lastName") + .setString("lastName", lastName + "%").list(); + } + + @Transactional(readOnly = true) + public Owner loadOwner(int id) { + return (Owner) sessionFactory.getCurrentSession().load(Owner.class, id); + } + + @Transactional(readOnly = true) + public Pet loadPet(int id) { + return (Pet) sessionFactory.getCurrentSession().load(Pet.class, id); + } + + public void storeOwner(Owner owner) { + // Note: Hibernate3's merge operation does not reassociate the object + // with the current Hibernate Session. Instead, it will always copy the + // state over to a registered representation of the entity. In case of a + // new entity, it will register a copy as well, but will not update the + // id of the passed-in object. To still update the ids of the original + // objects too, we need to register Spring's + // IdTransferringMergeEventListener on our SessionFactory. + sessionFactory.getCurrentSession().merge(owner); + } + + public void storePet(Pet pet) { + sessionFactory.getCurrentSession().merge(pet); + } + + public void storeVisit(Visit visit) { + sessionFactory.getCurrentSession().merge(visit); + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/hibernate/package.html b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/hibernate/package.html new file mode 100644 index 00000000000..56c54c796a8 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/hibernate/package.html @@ -0,0 +1,8 @@ + + + +The classes in this package represent the Hibernate implementation +of PetClinic's persistence layer. + + + diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/jdbc/JdbcPet.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/jdbc/JdbcPet.java new file mode 100644 index 00000000000..963ffdfe033 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/jdbc/JdbcPet.java @@ -0,0 +1,35 @@ +package org.springframework.samples.petclinic.jdbc; + +import org.springframework.samples.petclinic.Pet; + +/** + * Subclass of Pet that carries temporary id properties which + * are only relevant for a JDBC implmentation of the Clinic. + * + * @author Juergen Hoeller + * @see SimpleJdbcClinic + */ +class JdbcPet extends Pet { + + private int typeId; + + private int ownerId; + + + public void setTypeId(int typeId) { + this.typeId = typeId; + } + + public int getTypeId() { + return this.typeId; + } + + public void setOwnerId(int ownerId) { + this.ownerId = ownerId; + } + + public int getOwnerId() { + return this.ownerId; + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/jdbc/SimpleJdbcClinic.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/jdbc/SimpleJdbcClinic.java new file mode 100644 index 00000000000..6794c80ab56 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/jdbc/SimpleJdbcClinic.java @@ -0,0 +1,338 @@ +package org.springframework.samples.petclinic.jdbc; + +import java.sql.ResultSet; +import java.sql.SQLException; +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; + +import javax.sql.DataSource; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.dao.DataAccessException; +import org.springframework.dao.EmptyResultDataAccessException; +import org.springframework.jdbc.core.namedparam.BeanPropertySqlParameterSource; +import org.springframework.jdbc.core.namedparam.MapSqlParameterSource; +import org.springframework.jdbc.core.simple.ParameterizedBeanPropertyRowMapper; +import org.springframework.jdbc.core.simple.ParameterizedRowMapper; +import org.springframework.jdbc.core.simple.SimpleJdbcInsert; +import org.springframework.jdbc.core.simple.SimpleJdbcTemplate; +import org.springframework.jmx.export.annotation.ManagedOperation; +import org.springframework.jmx.export.annotation.ManagedResource; +import org.springframework.orm.ObjectRetrievalFailureException; +import org.springframework.samples.petclinic.Clinic; +import org.springframework.samples.petclinic.Owner; +import org.springframework.samples.petclinic.Pet; +import org.springframework.samples.petclinic.PetType; +import org.springframework.samples.petclinic.Specialty; +import org.springframework.samples.petclinic.Vet; +import org.springframework.samples.petclinic.Visit; +import org.springframework.samples.petclinic.util.EntityUtils; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +/** + * A simple JDBC-based implementation of the {@link Clinic} interface. + * + *

This class uses Java 5 language features and the {@link SimpleJdbcTemplate} + * plus {@link SimpleJdbcInsert}. It also takes advantage of classes like + * {@link BeanPropertySqlParameterSource} and + * {@link ParameterizedBeanPropertyRowMapper} which provide automatic mapping + * between JavaBean properties and JDBC parameters or query results. + * + *

SimpleJdbcClinic is a rewrite of the AbstractJdbcClinic which was the base + * class for JDBC implementations of the Clinic interface for Spring 2.0. + * + * @author Ken Krebs + * @author Juergen Hoeller + * @author Rob Harrop + * @author Sam Brannen + * @author Thomas Risberg + * @author Mark Fisher + */ +@Service +@ManagedResource("petclinic:type=Clinic") +public class SimpleJdbcClinic implements Clinic, SimpleJdbcClinicMBean { + + private final Log logger = LogFactory.getLog(getClass()); + + private SimpleJdbcTemplate simpleJdbcTemplate; + + private SimpleJdbcInsert insertOwner; + private SimpleJdbcInsert insertPet; + private SimpleJdbcInsert insertVisit; + + private final List vets = new ArrayList(); + + + @Autowired + public void init(DataSource dataSource) { + this.simpleJdbcTemplate = new SimpleJdbcTemplate(dataSource); + + this.insertOwner = new SimpleJdbcInsert(dataSource) + .withTableName("owners") + .usingGeneratedKeyColumns("id"); + this.insertPet = new SimpleJdbcInsert(dataSource) + .withTableName("pets") + .usingGeneratedKeyColumns("id"); + this.insertVisit = new SimpleJdbcInsert(dataSource) + .withTableName("visits") + .usingGeneratedKeyColumns("id"); + } + + + /** + * Refresh the cache of Vets that the Clinic is holding. + * @see org.springframework.samples.petclinic.Clinic#getVets() + */ + @ManagedOperation + @Transactional(readOnly = true) + public void refreshVetsCache() throws DataAccessException { + synchronized (this.vets) { + this.logger.info("Refreshing vets cache"); + + // Retrieve the list of all vets. + this.vets.clear(); + this.vets.addAll(this.simpleJdbcTemplate.query( + "SELECT id, first_name, last_name FROM vets ORDER BY last_name,first_name", + ParameterizedBeanPropertyRowMapper.newInstance(Vet.class))); + + // Retrieve the list of all possible specialties. + final List specialties = this.simpleJdbcTemplate.query( + "SELECT id, name FROM specialties", + ParameterizedBeanPropertyRowMapper.newInstance(Specialty.class)); + + // Build each vet's list of specialties. + for (Vet vet : this.vets) { + final List vetSpecialtiesIds = this.simpleJdbcTemplate.query( + "SELECT specialty_id FROM vet_specialties WHERE vet_id=?", + new ParameterizedRowMapper() { + public Integer mapRow(ResultSet rs, int row) throws SQLException { + return Integer.valueOf(rs.getInt(1)); + }}, + vet.getId().intValue()); + for (int specialtyId : vetSpecialtiesIds) { + Specialty specialty = EntityUtils.getById(specialties, Specialty.class, specialtyId); + vet.addSpecialty(specialty); + } + } + } + } + + + // START of Clinic implementation section ******************************* + + @Transactional(readOnly = true) + public Collection getVets() throws DataAccessException { + synchronized (this.vets) { + if (this.vets.isEmpty()) { + refreshVetsCache(); + } + return this.vets; + } + } + + @Transactional(readOnly = true) + public Collection getPetTypes() throws DataAccessException { + return this.simpleJdbcTemplate.query( + "SELECT id, name FROM types ORDER BY name", + ParameterizedBeanPropertyRowMapper.newInstance(PetType.class)); + } + + /** + * Loads {@link Owner Owners} from the data store by last name, returning + * all owners whose last name starts with the given name; also loads + * the {@link Pet Pets} and {@link Visit Visits} for the corresponding + * owners, if not already loaded. + */ + @Transactional(readOnly = true) + public Collection findOwners(String lastName) throws DataAccessException { + List owners = this.simpleJdbcTemplate.query( + "SELECT id, first_name, last_name, address, city, telephone FROM owners WHERE last_name like ?", + ParameterizedBeanPropertyRowMapper.newInstance(Owner.class), + lastName + "%"); + loadOwnersPetsAndVisits(owners); + return owners; + } + + /** + * Loads the {@link Owner} with the supplied id; also loads + * the {@link Pet Pets} and {@link Visit Visits} for the corresponding + * owner, if not already loaded. + */ + @Transactional(readOnly = true) + public Owner loadOwner(int id) throws DataAccessException { + Owner owner; + try { + owner = this.simpleJdbcTemplate.queryForObject( + "SELECT id, first_name, last_name, address, city, telephone FROM owners WHERE id=?", + ParameterizedBeanPropertyRowMapper.newInstance(Owner.class), + id); + } + catch (EmptyResultDataAccessException ex) { + throw new ObjectRetrievalFailureException(Owner.class, new Integer(id)); + } + loadPetsAndVisits(owner); + return owner; + } + + @Transactional(readOnly = true) + public Pet loadPet(int id) throws DataAccessException { + JdbcPet pet; + try { + pet = this.simpleJdbcTemplate.queryForObject( + "SELECT id, name, birth_date, type_id, owner_id FROM pets WHERE id=?", + new JdbcPetRowMapper(), + id); + } + catch (EmptyResultDataAccessException ex) { + throw new ObjectRetrievalFailureException(Pet.class, new Integer(id)); + } + Owner owner = loadOwner(pet.getOwnerId()); + owner.addPet(pet); + pet.setType(EntityUtils.getById(getPetTypes(), PetType.class, pet.getTypeId())); + loadVisits(pet); + return pet; + } + + @Transactional + public void storeOwner(Owner owner) throws DataAccessException { + if (owner.isNew()) { + Number newKey = this.insertOwner.executeAndReturnKey( + new BeanPropertySqlParameterSource(owner)); + owner.setId(newKey.intValue()); + } + else { + this.simpleJdbcTemplate.update( + "UPDATE owners SET first_name=:firstName, last_name=:lastName, address=:address, " + + "city=:city, telephone=:telephone WHERE id=:id", + new BeanPropertySqlParameterSource(owner)); + } + } + + @Transactional + public void storePet(Pet pet) throws DataAccessException { + if (pet.isNew()) { + Number newKey = this.insertPet.executeAndReturnKey( + createPetParameterSource(pet)); + pet.setId(newKey.intValue()); + } + else { + this.simpleJdbcTemplate.update( + "UPDATE pets SET name=:name, birth_date=:birth_date, type_id=:type_id, " + + "owner_id=:owner_id WHERE id=:id", + createPetParameterSource(pet)); + } + } + + @Transactional + public void storeVisit(Visit visit) throws DataAccessException { + if (visit.isNew()) { + Number newKey = this.insertVisit.executeAndReturnKey( + createVisitParameterSource(visit)); + visit.setId(newKey.intValue()); + } + else { + throw new UnsupportedOperationException("Visit update not supported"); + } + } + + // END of Clinic implementation section ************************************ + + + /** + * Creates a {@link MapSqlParameterSource} based on data values from the + * supplied {@link Pet} instance. + */ + private MapSqlParameterSource createPetParameterSource(Pet pet) { + return new MapSqlParameterSource() + .addValue("id", pet.getId()) + .addValue("name", pet.getName()) + .addValue("birth_date", pet.getBirthDate()) + .addValue("type_id", pet.getType().getId()) + .addValue("owner_id", pet.getOwner().getId()); + } + + /** + * Creates a {@link MapSqlParameterSource} based on data values from the + * supplied {@link Visit} instance. + */ + private MapSqlParameterSource createVisitParameterSource(Visit visit) { + return new MapSqlParameterSource() + .addValue("id", visit.getId()) + .addValue("visit_date", visit.getDate()) + .addValue("description", visit.getDescription()) + .addValue("pet_id", visit.getPet().getId()); + } + + /** + * Loads the {@link Visit} data for the supplied {@link Pet}. + */ + private void loadVisits(JdbcPet pet) { + final List visits = this.simpleJdbcTemplate.query( + "SELECT id, visit_date, description FROM visits WHERE pet_id=?", + new ParameterizedRowMapper() { + public Visit mapRow(ResultSet rs, int row) throws SQLException { + Visit visit = new Visit(); + visit.setId(rs.getInt("id")); + visit.setDate(rs.getTimestamp("visit_date")); + visit.setDescription(rs.getString("description")); + return visit; + } + }, + pet.getId().intValue()); + for (Visit visit : visits) { + pet.addVisit(visit); + } + } + + /** + * Loads the {@link Pet} and {@link Visit} data for the supplied + * {@link Owner}. + */ + private void loadPetsAndVisits(final Owner owner) { + final List pets = this.simpleJdbcTemplate.query( + "SELECT id, name, birth_date, type_id, owner_id FROM pets WHERE owner_id=?", + new JdbcPetRowMapper(), + owner.getId().intValue()); + for (JdbcPet pet : pets) { + owner.addPet(pet); + pet.setType(EntityUtils.getById(getPetTypes(), PetType.class, pet.getTypeId())); + loadVisits(pet); + } + } + + /** + * Loads the {@link Pet} and {@link Visit} data for the supplied + * {@link List} of {@link Owner Owners}. + * + * @param owners the list of owners for whom the pet and visit data should be loaded + * @see #loadPetsAndVisits(Owner) + */ + private void loadOwnersPetsAndVisits(List owners) { + for (Owner owner : owners) { + loadPetsAndVisits(owner); + } + } + + /** + * {@link ParameterizedRowMapper} implementation mapping data from a + * {@link ResultSet} to the corresponding properties of the {@link JdbcPet} class. + */ + private class JdbcPetRowMapper implements ParameterizedRowMapper { + + public JdbcPet mapRow(ResultSet rs, int rownum) throws SQLException { + JdbcPet pet = new JdbcPet(); + pet.setId(rs.getInt("id")); + pet.setName(rs.getString("name")); + pet.setBirthDate(rs.getDate("birth_date")); + pet.setTypeId(rs.getInt("type_id")); + pet.setOwnerId(rs.getInt("owner_id")); + return pet; + } + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/jdbc/SimpleJdbcClinicMBean.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/jdbc/SimpleJdbcClinicMBean.java new file mode 100644 index 00000000000..c9a7a78478b --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/jdbc/SimpleJdbcClinicMBean.java @@ -0,0 +1,20 @@ +package org.springframework.samples.petclinic.jdbc; + +/** + * Interface that defines a cache refresh operation. + * To be exposed for management via JMX. + * + * @author Rob Harrop + * @author Juergen Hoeller + * @see SimpleJdbcClinic + */ +public interface SimpleJdbcClinicMBean { + + /** + * Refresh the cache of Vets that the Clinic is holding. + * @see org.springframework.samples.petclinic.Clinic#getVets() + * @see SimpleJdbcClinic#refreshVetsCache() + */ + void refreshVetsCache(); + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/jdbc/package.html b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/jdbc/package.html new file mode 100644 index 00000000000..f3159f6a149 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/jdbc/package.html @@ -0,0 +1,8 @@ + + + +The classes in this package represent the JDBC implementation +of PetClinic's persistence layer. + + + diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/jpa/EntityManagerClinic.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/jpa/EntityManagerClinic.java new file mode 100644 index 00000000000..ff6907094d4 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/jpa/EntityManagerClinic.java @@ -0,0 +1,90 @@ +package org.springframework.samples.petclinic.jpa; + +import java.util.Collection; + +import javax.persistence.EntityManager; +import javax.persistence.PersistenceContext; +import javax.persistence.Query; + +import org.springframework.samples.petclinic.Clinic; +import org.springframework.samples.petclinic.Owner; +import org.springframework.samples.petclinic.Pet; +import org.springframework.samples.petclinic.PetType; +import org.springframework.samples.petclinic.Vet; +import org.springframework.samples.petclinic.Visit; +import org.springframework.stereotype.Repository; +import org.springframework.transaction.annotation.Transactional; + +/** + * JPA implementation of the Clinic interface using EntityManager. + * + *

The mappings are defined in "orm.xml" located in the META-INF directory. + * + * @author Mike Keith + * @author Rod Johnson + * @author Sam Brannen + * @since 22.4.2006 + */ +@Repository +@Transactional +public class EntityManagerClinic implements Clinic { + + @PersistenceContext + private EntityManager em; + + + @Transactional(readOnly = true) + @SuppressWarnings("unchecked") + public Collection getVets() { + return this.em.createQuery("SELECT vet FROM Vet vet ORDER BY vet.lastName, vet.firstName").getResultList(); + } + + @Transactional(readOnly = true) + @SuppressWarnings("unchecked") + public Collection getPetTypes() { + return this.em.createQuery("SELECT ptype FROM PetType ptype ORDER BY ptype.name").getResultList(); + } + + @Transactional(readOnly = true) + @SuppressWarnings("unchecked") + public Collection findOwners(String lastName) { + Query query = this.em.createQuery("SELECT owner FROM Owner owner WHERE owner.lastName LIKE :lastName"); + query.setParameter("lastName", lastName + "%"); + return query.getResultList(); + } + + @Transactional(readOnly = true) + public Owner loadOwner(int id) { + return this.em.find(Owner.class, id); + } + + @Transactional(readOnly = true) + public Pet loadPet(int id) { + return this.em.find(Pet.class, id); + } + + public void storeOwner(Owner owner) { + // Consider returning the persistent object here, for exposing + // a newly assigned id using any persistence provider... + Owner merged = this.em.merge(owner); + this.em.flush(); + owner.setId(merged.getId()); + } + + public void storePet(Pet pet) { + // Consider returning the persistent object here, for exposing + // a newly assigned id using any persistence provider... + Pet merged = this.em.merge(pet); + this.em.flush(); + pet.setId(merged.getId()); + } + + public void storeVisit(Visit visit) { + // Consider returning the persistent object here, for exposing + // a newly assigned id using any persistence provider... + Visit merged = this.em.merge(visit); + this.em.flush(); + visit.setId(merged.getId()); + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/jpa/package.html b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/jpa/package.html new file mode 100644 index 00000000000..f83c3ff78a7 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/jpa/package.html @@ -0,0 +1,8 @@ + + + +The classes in this package represent the JPA implementation +of PetClinic's persistence layer. + + + diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/package.html b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/package.html new file mode 100644 index 00000000000..5a705c8164c --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/package.html @@ -0,0 +1,7 @@ + + + +The classes in this package represent PetClinic's business layer. + + + diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/toplink/EssentialsHSQLPlatformWithNativeSequence.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/toplink/EssentialsHSQLPlatformWithNativeSequence.java new file mode 100644 index 00000000000..1086591decd --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/toplink/EssentialsHSQLPlatformWithNativeSequence.java @@ -0,0 +1,56 @@ +package org.springframework.samples.petclinic.toplink; + +import java.io.IOException; +import java.io.Writer; + +import oracle.toplink.essentials.exceptions.ValidationException; +import oracle.toplink.essentials.platform.database.HSQLPlatform; +import oracle.toplink.essentials.queryframework.ValueReadQuery; + +/** + * Subclass of the TopLink Essentials default HSQLPlatform class, using native + * HSQLDB identity columns for id generation. + * + *

Necessary for PetClinic's default data model, which relies on identity + * columns: this is uniformly used across all persistence layer implementations + * (JDBC, Hibernate, and JPA). + * + * @author Juergen Hoeller + * @author James Clark + * @since 1.2 + */ +public class EssentialsHSQLPlatformWithNativeSequence extends HSQLPlatform { + + private static final long serialVersionUID = -55658009691346735L; + + + public EssentialsHSQLPlatformWithNativeSequence() { + // setUsesNativeSequencing(true); + } + + @Override + public boolean supportsNativeSequenceNumbers() { + return true; + } + + @Override + public boolean shouldNativeSequenceAcquireValueAfterInsert() { + return true; + } + + @Override + public ValueReadQuery buildSelectQueryForNativeSequence() { + return new ValueReadQuery("CALL IDENTITY()"); + } + + @Override + public void printFieldIdentityClause(Writer writer) throws ValidationException { + try { + writer.write(" IDENTITY"); + } + catch (IOException ex) { + throw ValidationException.fileError(ex); + } + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/toplink/package.html b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/toplink/package.html new file mode 100644 index 00000000000..2782b4ce906 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/toplink/package.html @@ -0,0 +1,8 @@ + + + +The classes in this package provide support for using the TopLink +implementation with PetClinic's EntityManagerClinic. + + + diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/util/EntityUtils.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/util/EntityUtils.java new file mode 100644 index 00000000000..16df5fa9a91 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/util/EntityUtils.java @@ -0,0 +1,41 @@ + +package org.springframework.samples.petclinic.util; + +import java.util.Collection; + +import org.springframework.orm.ObjectRetrievalFailureException; +import org.springframework.samples.petclinic.BaseEntity; + +/** + * Utility methods for handling entities. Separate from the BaseEntity class + * mainly because of dependency on the ORM-associated + * ObjectRetrievalFailureException. + * + * @author Juergen Hoeller + * @author Sam Brannen + * @since 29.10.2003 + * @see org.springframework.samples.petclinic.BaseEntity + */ +public abstract class EntityUtils { + + /** + * Look up the entity of the given class with the given id in the given + * collection. + * + * @param entities the collection to search + * @param entityClass the entity class to look up + * @param entityId the entity id to look up + * @return the found entity + * @throws ObjectRetrievalFailureException if the entity was not found + */ + public static T getById(Collection entities, Class entityClass, int entityId) + throws ObjectRetrievalFailureException { + for (T entity : entities) { + if (entity.getId().intValue() == entityId && entityClass.isInstance(entity)) { + return entity; + } + } + throw new ObjectRetrievalFailureException(entityClass, new Integer(entityId)); + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/validation/OwnerValidator.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/validation/OwnerValidator.java new file mode 100644 index 00000000000..04b6b7d58af --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/validation/OwnerValidator.java @@ -0,0 +1,43 @@ +package org.springframework.samples.petclinic.validation; + +import org.springframework.samples.petclinic.Owner; +import org.springframework.util.StringUtils; +import org.springframework.validation.Errors; + +/** + * Validator for Owner forms. + * + * @author Ken Krebs + * @author Juergen Hoeller + */ +public class OwnerValidator { + + public void validate(Owner owner, Errors errors) { + if (!StringUtils.hasLength(owner.getFirstName())) { + errors.rejectValue("firstName", "required", "required"); + } + if (!StringUtils.hasLength(owner.getLastName())) { + errors.rejectValue("lastName", "required", "required"); + } + if (!StringUtils.hasLength(owner.getAddress())) { + errors.rejectValue("address", "required", "required"); + } + if (!StringUtils.hasLength(owner.getCity())) { + errors.rejectValue("city", "required", "required"); + } + + String telephone = owner.getTelephone(); + if (!StringUtils.hasLength(telephone)) { + errors.rejectValue("telephone", "required", "required"); + } + else { + for (int i = 0; i < telephone.length(); ++i) { + if ((Character.isDigit(telephone.charAt(i))) == false) { + errors.rejectValue("telephone", "nonNumeric", "non-numeric"); + break; + } + } + } + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/validation/PetValidator.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/validation/PetValidator.java new file mode 100644 index 00000000000..8ad6eb0ac03 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/validation/PetValidator.java @@ -0,0 +1,25 @@ +package org.springframework.samples.petclinic.validation; + +import org.springframework.samples.petclinic.Pet; +import org.springframework.util.StringUtils; +import org.springframework.validation.Errors; + +/** + * Validator for Pet forms. + * + * @author Ken Krebs + * @author Juergen Hoeller + */ +public class PetValidator { + + public void validate(Pet pet, Errors errors) { + String name = pet.getName(); + if (!StringUtils.hasLength(name)) { + errors.rejectValue("name", "required", "required"); + } + else if (pet.isNew() && pet.getOwner().getPet(name, true) != null) { + errors.rejectValue("name", "duplicate", "already exists"); + } + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/validation/VisitValidator.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/validation/VisitValidator.java new file mode 100644 index 00000000000..35c80bafa10 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/validation/VisitValidator.java @@ -0,0 +1,21 @@ +package org.springframework.samples.petclinic.validation; + +import org.springframework.samples.petclinic.Visit; +import org.springframework.util.StringUtils; +import org.springframework.validation.Errors; + +/** + * Validator for Visit forms. + * + * @author Ken Krebs + * @author Juergen Hoeller + */ +public class VisitValidator { + + public void validate(Visit visit, Errors errors) { + if (!StringUtils.hasLength(visit.getDescription())) { + errors.rejectValue("description", "required", "required"); + } + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/validation/package.html b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/validation/package.html new file mode 100644 index 00000000000..f83530e221b --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/validation/package.html @@ -0,0 +1,8 @@ + + + +The classes in this package represent the set of Validator objects +the Business Layer makes available to the Presentation Layer. + + + diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/AddOwnerForm.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/AddOwnerForm.java new file mode 100644 index 00000000000..4f05867d325 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/AddOwnerForm.java @@ -0,0 +1,62 @@ +package org.springframework.samples.petclinic.web; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.samples.petclinic.Clinic; +import org.springframework.samples.petclinic.Owner; +import org.springframework.samples.petclinic.validation.OwnerValidator; +import org.springframework.stereotype.Controller; +import org.springframework.ui.Model; +import org.springframework.validation.BindingResult; +import org.springframework.web.bind.annotation.ModelAttribute; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.SessionAttributes; +import org.springframework.web.bind.annotation.InitBinder; +import org.springframework.web.bind.support.SessionStatus; +import org.springframework.web.bind.WebDataBinder; + +/** + * JavaBean form controller that is used to add a new Owner to + * the system. + * + * @author Juergen Hoeller + * @author Ken Krebs + */ +@Controller +@RequestMapping("/addOwner.do") +@SessionAttributes(types = Owner.class) +public class AddOwnerForm { + + private final Clinic clinic; + + @Autowired + public AddOwnerForm(Clinic clinic) { + this.clinic = clinic; + } + + @InitBinder + public void setAllowedFields(WebDataBinder dataBinder) { + dataBinder.setDisallowedFields(new String[] {"id"}); + } + + @RequestMapping(method = RequestMethod.GET) + public String setupForm(Model model) { + Owner owner = new Owner(); + model.addAttribute(owner); + return "ownerForm"; + } + + @RequestMapping(method = RequestMethod.POST) + public String processSubmit(@ModelAttribute Owner owner, BindingResult result, SessionStatus status) { + new OwnerValidator().validate(owner, result); + if (result.hasErrors()) { + return "ownerForm"; + } + else { + this.clinic.storeOwner(owner); + status.setComplete(); + return "redirect:owner.do?ownerId=" + owner.getId(); + } + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/AddPetForm.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/AddPetForm.java new file mode 100644 index 00000000000..62d72349796 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/AddPetForm.java @@ -0,0 +1,74 @@ +package org.springframework.samples.petclinic.web; + +import java.util.Collection; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.samples.petclinic.Clinic; +import org.springframework.samples.petclinic.Owner; +import org.springframework.samples.petclinic.Pet; +import org.springframework.samples.petclinic.PetType; +import org.springframework.samples.petclinic.validation.PetValidator; +import org.springframework.stereotype.Controller; +import org.springframework.ui.Model; +import org.springframework.validation.BindingResult; +import org.springframework.web.bind.annotation.ModelAttribute; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.SessionAttributes; +import org.springframework.web.bind.annotation.InitBinder; +import org.springframework.web.bind.support.SessionStatus; +import org.springframework.web.bind.WebDataBinder; + +/** + * JavaBean form controller that is used to add a new Pet to the + * system. + * + * @author Juergen Hoeller + * @author Ken Krebs + */ +@Controller +@RequestMapping("/addPet.do") +@SessionAttributes("pet") +public class AddPetForm { + + private final Clinic clinic; + + @Autowired + public AddPetForm(Clinic clinic) { + this.clinic = clinic; + } + + @ModelAttribute("types") + public Collection populatePetTypes() { + return this.clinic.getPetTypes(); + } + + @InitBinder + public void setAllowedFields(WebDataBinder dataBinder) { + dataBinder.setDisallowedFields(new String[] {"id"}); + } + + @RequestMapping(method = RequestMethod.GET) + public String setupForm(@RequestParam("ownerId") int ownerId, Model model) { + Owner owner = this.clinic.loadOwner(ownerId); + Pet pet = new Pet(); + owner.addPet(pet); + model.addAttribute("pet", pet); + return "petForm"; + } + + @RequestMapping(method = RequestMethod.POST) + public String processSubmit(@ModelAttribute("pet") Pet pet, BindingResult result, SessionStatus status) { + new PetValidator().validate(pet, result); + if (result.hasErrors()) { + return "petForm"; + } + else { + this.clinic.storePet(pet); + status.setComplete(); + return "redirect:owner.do?ownerId=" + pet.getOwner().getId(); + } + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/AddVisitForm.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/AddVisitForm.java new file mode 100644 index 00000000000..10015e18bc5 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/AddVisitForm.java @@ -0,0 +1,66 @@ +package org.springframework.samples.petclinic.web; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.samples.petclinic.Clinic; +import org.springframework.samples.petclinic.Pet; +import org.springframework.samples.petclinic.Visit; +import org.springframework.samples.petclinic.validation.VisitValidator; +import org.springframework.stereotype.Controller; +import org.springframework.ui.Model; +import org.springframework.validation.BindingResult; +import org.springframework.web.bind.annotation.ModelAttribute; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.SessionAttributes; +import org.springframework.web.bind.annotation.InitBinder; +import org.springframework.web.bind.support.SessionStatus; +import org.springframework.web.bind.WebDataBinder; + +/** + * JavaBean form controller that is used to add a new Visit to + * the system. + * + * @author Juergen Hoeller + * @author Ken Krebs + */ +@Controller +@RequestMapping("/addVisit.do") +@SessionAttributes("visit") +public class AddVisitForm { + + private final Clinic clinic; + + @Autowired + public AddVisitForm(Clinic clinic) { + this.clinic = clinic; + } + + @InitBinder + public void setAllowedFields(WebDataBinder dataBinder) { + dataBinder.setDisallowedFields(new String[] {"id"}); + } + + @RequestMapping(method = RequestMethod.GET) + public String setupForm(@RequestParam("petId") int petId, Model model) { + Pet pet = this.clinic.loadPet(petId); + Visit visit = new Visit(); + pet.addVisit(visit); + model.addAttribute("visit", visit); + return "visitForm"; + } + + @RequestMapping(method = RequestMethod.POST) + public String processSubmit(@ModelAttribute("visit") Visit visit, BindingResult result, SessionStatus status) { + new VisitValidator().validate(visit, result); + if (result.hasErrors()) { + return "visitForm"; + } + else { + this.clinic.storeVisit(visit); + status.setComplete(); + return "redirect:owner.do?ownerId=" + visit.getPet().getOwner().getId(); + } + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/ClinicBindingInitializer.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/ClinicBindingInitializer.java new file mode 100644 index 00000000000..2d2a8bdc15f --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/ClinicBindingInitializer.java @@ -0,0 +1,37 @@ +package org.springframework.samples.petclinic.web; + +import java.text.SimpleDateFormat; +import java.util.Date; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.propertyeditors.CustomDateEditor; +import org.springframework.beans.propertyeditors.StringTrimmerEditor; +import org.springframework.samples.petclinic.Clinic; +import org.springframework.samples.petclinic.PetType; +import org.springframework.web.bind.WebDataBinder; +import org.springframework.web.bind.support.WebBindingInitializer; +import org.springframework.web.context.request.WebRequest; + +/** + * Shared WebBindingInitializer for PetClinic's custom editors. + * + *

Alternatively, such init-binder code may be put into + * {@link org.springframework.web.bind.annotation.InitBinder} + * annotated methods on the controller classes themselves. + * + * @author Juergen Hoeller + */ +public class ClinicBindingInitializer implements WebBindingInitializer { + + @Autowired + private Clinic clinic; + + public void initBinder(WebDataBinder binder, WebRequest request) { + SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd"); + dateFormat.setLenient(false); + binder.registerCustomEditor(Date.class, new CustomDateEditor(dateFormat, false)); + binder.registerCustomEditor(String.class, new StringTrimmerEditor(false)); + binder.registerCustomEditor(PetType.class, new PetTypeEditor(this.clinic)); + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/ClinicController.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/ClinicController.java new file mode 100644 index 00000000000..5ac90f581ec --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/ClinicController.java @@ -0,0 +1,72 @@ + +package org.springframework.samples.petclinic.web; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.samples.petclinic.Clinic; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestParam; + +/** + * Annotation-driven MultiActionController that handles all non-form + * URL's. + * + * @author Juergen Hoeller + * @author Mark Fisher + * @author Ken Krebs + */ +@Controller +public class ClinicController { + + private final Clinic clinic; + + + @Autowired + public ClinicController(Clinic clinic) { + this.clinic = clinic; + } + + /** + * Custom handler for the welcome view. + *

+ * Note that this handler relies on the RequestToViewNameTranslator to + * determine the logical view name based on the request URL: "/welcome.do" + * -> "welcome". + */ + @RequestMapping("/welcome.do") + public void welcomeHandler() { + } + + /** + * Custom handler for displaying vets. + *

+ * Note that this handler returns a plain {@link ModelMap} object instead of + * a ModelAndView, thus leveraging convention-based model attribute names. + * It relies on the RequestToViewNameTranslator to determine the logical + * view name based on the request URL: "/vets.do" -> "vets". + * + * @return a ModelMap with the model attributes for the view + */ + @RequestMapping("/vets.do") + public ModelMap vetsHandler() { + return new ModelMap(this.clinic.getVets()); + } + + /** + * Custom handler for displaying an owner. + *

+ * Note that this handler returns a plain {@link ModelMap} object instead of + * a ModelAndView, thus leveraging convention-based model attribute names. + * It relies on the RequestToViewNameTranslator to determine the logical + * view name based on the request URL: "/owner.do" -> "owner". + * + * @param ownerId the ID of the owner to display + * @return a ModelMap with the model attributes for the view + */ + @RequestMapping("/owner.do") + public ModelMap ownerHandler(@RequestParam("ownerId") int ownerId) { + return new ModelMap(this.clinic.loadOwner(ownerId)); + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/EditOwnerForm.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/EditOwnerForm.java new file mode 100644 index 00000000000..424c184c54a --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/EditOwnerForm.java @@ -0,0 +1,62 @@ +package org.springframework.samples.petclinic.web; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.samples.petclinic.Clinic; +import org.springframework.samples.petclinic.Owner; +import org.springframework.samples.petclinic.validation.OwnerValidator; +import org.springframework.stereotype.Controller; +import org.springframework.ui.Model; +import org.springframework.validation.BindingResult; +import org.springframework.web.bind.annotation.ModelAttribute; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.SessionAttributes; +import org.springframework.web.bind.annotation.InitBinder; +import org.springframework.web.bind.support.SessionStatus; +import org.springframework.web.bind.WebDataBinder; + +/** + * JavaBean Form controller that is used to edit an existing Owner. + * + * @author Juergen Hoeller + * @author Ken Krebs + */ +@Controller +@RequestMapping("/editOwner.do") +@SessionAttributes(types = Owner.class) +public class EditOwnerForm { + + private final Clinic clinic; + + @Autowired + public EditOwnerForm(Clinic clinic) { + this.clinic = clinic; + } + + @InitBinder + public void setAllowedFields(WebDataBinder dataBinder) { + dataBinder.setDisallowedFields(new String[] {"id"}); + } + + @RequestMapping(method = RequestMethod.GET) + public String setupForm(@RequestParam("ownerId") int ownerId, Model model) { + Owner owner = this.clinic.loadOwner(ownerId); + model.addAttribute(owner); + return "ownerForm"; + } + + @RequestMapping(method = RequestMethod.POST) + public String processSubmit(@ModelAttribute Owner owner, BindingResult result, SessionStatus status) { + new OwnerValidator().validate(owner, result); + if (result.hasErrors()) { + return "ownerForm"; + } + else { + this.clinic.storeOwner(owner); + status.setComplete(); + return "redirect:owner.do?ownerId=" + owner.getId(); + } + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/EditPetForm.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/EditPetForm.java new file mode 100644 index 00000000000..0a1033e669f --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/EditPetForm.java @@ -0,0 +1,70 @@ +package org.springframework.samples.petclinic.web; + +import java.util.Collection; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.samples.petclinic.Clinic; +import org.springframework.samples.petclinic.Pet; +import org.springframework.samples.petclinic.PetType; +import org.springframework.samples.petclinic.validation.PetValidator; +import org.springframework.stereotype.Controller; +import org.springframework.ui.Model; +import org.springframework.validation.BindingResult; +import org.springframework.web.bind.annotation.ModelAttribute; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.SessionAttributes; +import org.springframework.web.bind.annotation.InitBinder; +import org.springframework.web.bind.support.SessionStatus; +import org.springframework.web.bind.WebDataBinder; + +/** + * JavaBean Form controller that is used to edit an existing Pet. + * + * @author Juergen Hoeller + * @author Ken Krebs + */ +@Controller +@RequestMapping("/editPet.do") +@SessionAttributes("pet") +public class EditPetForm { + + private final Clinic clinic; + + @Autowired + public EditPetForm(Clinic clinic) { + this.clinic = clinic; + } + + @ModelAttribute("types") + public Collection populatePetTypes() { + return this.clinic.getPetTypes(); + } + + @InitBinder + public void setAllowedFields(WebDataBinder dataBinder) { + dataBinder.setDisallowedFields(new String[] {"id"}); + } + + @RequestMapping(method = RequestMethod.GET) + public String setupForm(@RequestParam("petId") int petId, Model model) { + Pet pet = this.clinic.loadPet(petId); + model.addAttribute("pet", pet); + return "petForm"; + } + + @RequestMapping(method = RequestMethod.POST) + public String processSubmit(@ModelAttribute("pet") Pet pet, BindingResult result, SessionStatus status) { + new PetValidator().validate(pet, result); + if (result.hasErrors()) { + return "petForm"; + } + else { + this.clinic.storePet(pet); + status.setComplete(); + return "redirect:owner.do?ownerId=" + pet.getOwner().getId(); + } + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/FindOwnersForm.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/FindOwnersForm.java new file mode 100644 index 00000000000..e0ea8efdf2f --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/FindOwnersForm.java @@ -0,0 +1,66 @@ +package org.springframework.samples.petclinic.web; + +import java.util.Collection; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.samples.petclinic.Clinic; +import org.springframework.samples.petclinic.Owner; +import org.springframework.stereotype.Controller; +import org.springframework.ui.Model; +import org.springframework.validation.BindingResult; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.InitBinder; +import org.springframework.web.bind.WebDataBinder; + +/** + * JavaBean Form controller that is used to search for Owners by + * last name. + * + * @author Juergen Hoeller + * @author Ken Krebs + */ +@Controller +@RequestMapping("/findOwners.do") +public class FindOwnersForm { + + private final Clinic clinic; + + @Autowired + public FindOwnersForm(Clinic clinic) { + this.clinic = clinic; + } + + @InitBinder + public void setAllowedFields(WebDataBinder dataBinder) { + dataBinder.setDisallowedFields(new String[] {"id"}); + } + + @RequestMapping(method = RequestMethod.GET) + public String setupForm(Model model) { + model.addAttribute("owner", new Owner()); + return "findOwners"; + } + + @RequestMapping(method = RequestMethod.POST) + public String processSubmit(Owner owner, BindingResult result, Model model) { + // find owners by last name + Collection results = this.clinic.findOwners(owner.getLastName()); + if (results.size() < 1) { + // no owners found + result.rejectValue("lastName", "notFound", "not found"); + return "findOwners"; + } + if (results.size() > 1) { + // multiple owners found + model.addAttribute("selections", results); + return "owners"; + } + else { + // 1 owner found + owner = results.iterator().next(); + return "redirect:owner.do?ownerId=" + owner.getId(); + } + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/PetTypeEditor.java b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/PetTypeEditor.java new file mode 100644 index 00000000000..812b648d711 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/PetTypeEditor.java @@ -0,0 +1,30 @@ +package org.springframework.samples.petclinic.web; + +import java.beans.PropertyEditorSupport; + +import org.springframework.samples.petclinic.Clinic; +import org.springframework.samples.petclinic.PetType; + +/** + * @author Mark Fisher + * @author Juergen Hoeller + */ +public class PetTypeEditor extends PropertyEditorSupport { + + private final Clinic clinic; + + + public PetTypeEditor(Clinic clinic) { + this.clinic = clinic; + } + + @Override + public void setAsText(String text) throws IllegalArgumentException { + for (PetType type : this.clinic.getPetTypes()) { + if (type.getName().equals(text)) { + setValue(type); + } + } + } + +} diff --git a/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/package.html b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/package.html new file mode 100644 index 00000000000..fe2089a3fcb --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/org/springframework/samples/petclinic/web/package.html @@ -0,0 +1,7 @@ + + + +The classes in this package represent PetClinic's web presentation layer. + + + diff --git a/org.springframework.samples.petclinic/src/main/java/overview.html b/org.springframework.samples.petclinic/src/main/java/overview.html new file mode 100644 index 00000000000..1eb7a2e8c19 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/java/overview.html @@ -0,0 +1,7 @@ + + +

+The Spring Data Binding framework, an internal library used by Spring Web Flow. +

+ + \ No newline at end of file diff --git a/org.springframework.samples.petclinic/src/main/resources/META-INF/aop.xml b/org.springframework.samples.petclinic/src/main/resources/META-INF/aop.xml new file mode 100644 index 00000000000..b49ffd8b19a --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/resources/META-INF/aop.xml @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + + + + diff --git a/org.springframework.samples.petclinic/src/main/resources/META-INF/orm.xml b/org.springframework.samples.petclinic/src/main/resources/META-INF/orm.xml new file mode 100644 index 00000000000..d7c8f7040a1 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/resources/META-INF/orm.xml @@ -0,0 +1,122 @@ + + + + + + + PROPERTY + + + + org.springframework.samples.petclinic + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + + + + + + + + + + +
+ + + + DATE + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + DATE + + + + + + + + + + diff --git a/org.springframework.samples.petclinic/src/main/resources/META-INF/persistence.xml b/org.springframework.samples.petclinic/src/main/resources/META-INF/persistence.xml new file mode 100644 index 00000000000..86bf7c115d8 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/resources/META-INF/persistence.xml @@ -0,0 +1,16 @@ + + + + + + META-INF/orm.xml + + + true + + + + diff --git a/org.springframework.samples.petclinic/src/main/resources/jdbc.properties b/org.springframework.samples.petclinic/src/main/resources/jdbc.properties new file mode 100644 index 00000000000..4a05a4620e6 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/resources/jdbc.properties @@ -0,0 +1,48 @@ +# Properties file with JDBC and JPA settings. +# +# Applied by from +# various application context XML files (e.g., "applicationContext-*.xml"). +# Targeted at system administrators, to avoid touching the context XML files. + +#------------------------------------------------------------------------------- +# Common Settings + +hibernate.generate_statistics=true +hibernate.show_sql=true +jpa.showSql=true + +#------------------------------------------------------------------------------- +# HSQL Settings + +jdbc.driverClassName=org.hsqldb.jdbcDriver +jdbc.url=jdbc:hsqldb:hsql://localhost:9001 +jdbc.username=sa +jdbc.password= + +# Property that determines which Hibernate dialect to use +# (only applied with "applicationContext-hibernate.xml") +hibernate.dialect=org.hibernate.dialect.HSQLDialect + +# Property that determines which JPA DatabasePlatform to use with TopLink Essentials +jpa.databasePlatform=org.springframework.samples.petclinic.toplink.EssentialsHSQLPlatformWithNativeSequence + +# Property that determines which database to use with an AbstractJpaVendorAdapter +jpa.database=HSQL + +#------------------------------------------------------------------------------- +# MySQL Settings + +#jdbc.driverClassName=com.mysql.jdbc.Driver +#jdbc.url=jdbc:mysql://localhost:3306/petclinic +#jdbc.username=pc +#jdbc.password=pc + +# Property that determines which Hibernate dialect to use +# (only applied with "applicationContext-hibernate.xml") +#hibernate.dialect=org.hibernate.dialect.MySQLDialect + +# Property that determines which JPA DatabasePlatform to use with TopLink Essentials +#jpa.databasePlatform=oracle.toplink.essentials.platform.database.MySQL4Platform + +# Property that determines which database to use with an AbstractJpaVendorAdapter +#jpa.database=MYSQL diff --git a/org.springframework.samples.petclinic/src/main/resources/petclinic.hbm.xml b/org.springframework.samples.petclinic/src/main/resources/petclinic.hbm.xml new file mode 100644 index 00000000000..f9a993cf121 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/resources/petclinic.hbm.xml @@ -0,0 +1,74 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/org.springframework.samples.petclinic/src/main/webapp/META-INF/context.xml b/org.springframework.samples.petclinic/src/main/webapp/META-INF/context.xml new file mode 100644 index 00000000000..d5deabaf701 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/META-INF/context.xml @@ -0,0 +1,7 @@ + + + + + diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/applicationContext-hibernate.xml b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/applicationContext-hibernate.xml new file mode 100644 index 00000000000..bfc166db625 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/applicationContext-hibernate.xml @@ -0,0 +1,89 @@ + + + + + + + + + + + + + + + + + + + + + ${hibernate.dialect} + ${hibernate.show_sql} + ${hibernate.generate_statistics} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/applicationContext-jdbc.xml b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/applicationContext-jdbc.xml new file mode 100644 index 00000000000..2a50b4905b5 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/applicationContext-jdbc.xml @@ -0,0 +1,81 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/applicationContext-jpa.xml b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/applicationContext-jpa.xml new file mode 100644 index 00000000000..25374e9abe2 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/applicationContext-jpa.xml @@ -0,0 +1,101 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/classes/log4j.properties b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/classes/log4j.properties new file mode 100644 index 00000000000..ebee551aa88 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/classes/log4j.properties @@ -0,0 +1,18 @@ +# For JBoss: Avoid to setup Log4J outside $JBOSS_HOME/server/default/deploy/log4j.xml! +# For all other servers: Comment out the Log4J listener in web.xml to activate Log4J. +log4j.rootLogger=INFO, stdout, logfile + +log4j.appender.stdout=org.apache.log4j.ConsoleAppender +log4j.appender.stdout.layout=org.apache.log4j.PatternLayout +log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - <%m>%n + +log4j.appender.logfile=org.apache.log4j.RollingFileAppender +log4j.appender.logfile.File=${petclinic.root}/WEB-INF/petclinic.log +log4j.appender.logfile.MaxFileSize=512KB +# Keep three backup files. +log4j.appender.logfile.MaxBackupIndex=3 +# Pattern to output: date priority [category] - message +log4j.appender.logfile.layout=org.apache.log4j.PatternLayout +log4j.appender.logfile.layout.ConversionPattern=%d %p [%c] - %m%n + +log4j.logger.org.springframework.samples.petclinic.aspects=DEBUG diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/classes/messages.properties b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/classes/messages.properties new file mode 100644 index 00000000000..173417a1014 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/classes/messages.properties @@ -0,0 +1,8 @@ +welcome=Welcome +required=is required +notFound=has not been found +duplicate=is already in use +nonNumeric=must be all numeric +duplicateFormSubmission=Duplicate form submission is not allowed +typeMismatch.date=invalid date +typeMismatch.birthDate=invalid date diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/classes/messages_de.properties b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/classes/messages_de.properties new file mode 100644 index 00000000000..124bee48b2c --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/classes/messages_de.properties @@ -0,0 +1,8 @@ +welcome=Willkommen +required=muss angegeben werden +notFound=wurde nicht gefunden +duplicate=ist bereits vergeben +nonNumeric=darf nur numerisch sein +duplicateFormSubmission=Wiederholtes Absenden des Formulars ist nicht erlaubt +typeMismatch.date=ungültiges Datum +typeMismatch.birthDate=ungültiges Datum diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/classes/messages_en.properties b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/classes/messages_en.properties new file mode 100644 index 00000000000..05d519bb86d --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/classes/messages_en.properties @@ -0,0 +1 @@ +# This file is intentionally empty. Message look-ups will fall back to the default "messages.properties" file. \ No newline at end of file diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/geronimo-web.xml b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/geronimo-web.xml new file mode 100644 index 00000000000..b5d88e1ecd2 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/geronimo-web.xml @@ -0,0 +1,6 @@ + + + /petclinic + true + \ No newline at end of file diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/dataAccessFailure.jsp b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/dataAccessFailure.jsp new file mode 100644 index 00000000000..1a2c758e899 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/dataAccessFailure.jsp @@ -0,0 +1,19 @@ +<%@ include file="/WEB-INF/jsp/includes.jsp" %> +<%@ include file="/WEB-INF/jsp/header.jsp" %> + +<% +Exception ex = (Exception) request.getAttribute("exception"); +%> + +

Data access failure: <%= ex.getMessage() %>

+

+ +<% +ex.printStackTrace(new java.io.PrintWriter(out)); +%> + +

+
+">Home + +<%@ include file="/WEB-INF/jsp/footer.jsp" %> diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/findOwners.jsp b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/findOwners.jsp new file mode 100644 index 00000000000..c2c15e080ea --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/findOwners.jsp @@ -0,0 +1,24 @@ +<%@ include file="/WEB-INF/jsp/includes.jsp" %> +<%@ include file="/WEB-INF/jsp/header.jsp" %> + +

Find Owners:

+ + +
+ + + + + + +
+ Last Name: +
+ +

+ + +
+">Add Owner + +<%@ include file="/WEB-INF/jsp/footer.jsp" %> diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/footer.jsp b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/footer.jsp new file mode 100644 index 00000000000..c9b0ac1b377 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/footer.jsp @@ -0,0 +1,12 @@ + + + + + + +
">Home"/>
+ + + + + diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/header.jsp b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/header.jsp new file mode 100644 index 00000000000..c8c08c25d03 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/header.jsp @@ -0,0 +1,14 @@ + + + + + + " type="text/css"/> + PetClinic :: a Spring Framework demonstration + + + + +
diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/includes.jsp b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/includes.jsp new file mode 100644 index 00000000000..a703287ee46 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/includes.jsp @@ -0,0 +1,4 @@ +<%@ taglib prefix="spring" uri="http://www.springframework.org/tags" %> +<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %> +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> +<%@ taglib prefix="fmt" uri="http://java.sun.com/jsp/jstl/fmt" %> diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/owner.jsp b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/owner.jsp new file mode 100644 index 00000000000..dc4724c6b4d --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/owner.jsp @@ -0,0 +1,98 @@ +<%@ include file="/WEB-INF/jsp/includes.jsp" %> +<%@ include file="/WEB-INF/jsp/header.jsp" %> + +

Owner Information

+ + + + + + + + + + + + + + + + + + +
Name${owner.firstName} ${owner.lastName}
Address${owner.address}
City${owner.city}
Telephone ${owner.telephone}
+ + + + + +
+
"> + +

+
+ 		+
" name="formAddPet"> + +

+
+
+ +

Pets and Visits

+ + + + + + + +
+ + + + + + + + + + + + + +
Name${pet.name}
Birth Date
Type${pet.type.name}
+ 		+ + + + + + + + + + + + + +
Visit DateDescription
${visit.description}
+
+ + + + + +
+
" name="formEditPet${pet.id}"> + +

+
+ 		+
" name="formVisitPet${pet.id}"> + +

+
+
+ + +<%@ include file="/WEB-INF/jsp/footer.jsp" %> diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/ownerForm.jsp b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/ownerForm.jsp new file mode 100644 index 00000000000..5cf1104696a --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/ownerForm.jsp @@ -0,0 +1,58 @@ +<%@ include file="/WEB-INF/jsp/includes.jsp" %> +<%@ include file="/WEB-INF/jsp/header.jsp" %> + +

New Owner:

+ + + + + + + + + + + + + + + + + + + + + +
+ First Name: +
+ +
+ Last Name: +
+ +
+ Address: +
+ +
+ City: +
+ +
+ Telephone: +
+ +
+ + +

+ + +

+ + +
+ + +<%@ include file="/WEB-INF/jsp/footer.jsp" %> diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/owners.jsp b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/owners.jsp new file mode 100644 index 00000000000..b9b5688a052 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/owners.jsp @@ -0,0 +1,33 @@ +<%@ include file="/WEB-INF/jsp/includes.jsp" %> +<%@ include file="/WEB-INF/jsp/header.jsp" %> + +

Owners:

+ + + + + + + + + + + + + + + + + + + + +
NameAddressCityTelephonePets
+ ${owner.firstName} ${owner.lastName} + ${owner.address}${owner.city}${owner.telephone} + + ${pet.name}   + +
+ +<%@ include file="/WEB-INF/jsp/footer.jsp" %> diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/petForm.jsp b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/petForm.jsp new file mode 100644 index 00000000000..49ba1de8608 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/petForm.jsp @@ -0,0 +1,47 @@ +<%@ include file="/WEB-INF/jsp/includes.jsp" %> +<%@ include file="/WEB-INF/jsp/header.jsp" %> + +

New Pet

+ +Owner: ${pet.owner.firstName} ${pet.owner.lastName} +
+ + + + + + + + + + + + + + + +
+ Name: +
+ +
+ Birth Date: +
+ (yyyy-mm-dd) +
+ Type: +
+ +
+ + +

+ + +

+ + +
+ + +<%@ include file="/WEB-INF/jsp/footer.jsp" %> diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/uncaughtException.jsp b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/uncaughtException.jsp new file mode 100644 index 00000000000..e97fdf37889 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/uncaughtException.jsp @@ -0,0 +1,49 @@ +<%@ include file="/WEB-INF/jsp/includes.jsp" %> +<%@ include file="/WEB-INF/jsp/header.jsp" %> + +

Internal error

+

+ +<% +try { + // The Servlet spec guarantees this attribute will be available + Throwable exception = (Throwable) request.getAttribute("javax.servlet.error.exception"); + + if (exception != null) { + if (exception instanceof ServletException) { + // It's a ServletException: we should extract the root cause + ServletException sex = (ServletException) exception; + Throwable rootCause = sex.getRootCause(); + if (rootCause == null) + rootCause = sex; + out.println("** Root cause is: "+ rootCause.getMessage()); + rootCause.printStackTrace(new java.io.PrintWriter(out)); + } + else { + // It's not a ServletException, so we'll just show it + exception.printStackTrace(new java.io.PrintWriter(out)); + } + } + else { + out.println("No error information available"); + } + + // Display cookies + out.println("\nCookies:\n"); + Cookie[] cookies = request.getCookies(); + if (cookies != null) { + for (int i = 0; i < cookies.length; i++) { + out.println(cookies[i].getName() + "=[" + cookies[i].getValue() + "]"); + } + } + +} catch (Exception ex) { + ex.printStackTrace(new java.io.PrintWriter(out)); +} +%> + +

+
+ + +<%@ include file="/WEB-INF/jsp/footer.jsp" %> diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/vets.jsp b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/vets.jsp new file mode 100644 index 00000000000..2ee6d20b71f --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/vets.jsp @@ -0,0 +1,26 @@ +<%@ include file="/WEB-INF/jsp/includes.jsp" %> +<%@ include file="/WEB-INF/jsp/header.jsp" %> + +

Veterinarians:

+ + + + + + + + + + + + + + +
NameSpecialties
${vet.firstName} ${vet.lastName} + + ${specialty.name} + + none +
+ +<%@ include file="/WEB-INF/jsp/footer.jsp" %> diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/visitForm.jsp b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/visitForm.jsp new file mode 100644 index 00000000000..f9be4067a61 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/visitForm.jsp @@ -0,0 +1,70 @@ +<%@ include file="/WEB-INF/jsp/includes.jsp" %> +<%@ include file="/WEB-INF/jsp/header.jsp" %> + +

New Visit:

+ + + Pet: + + + + + + + + + + + + + + + +
NameBirth DateTypeOwner
${visit.pet.name}${visit.pet.type.name}${visit.pet.owner.firstName} ${visit.pet.owner.lastName}
+ + + + + + + + + + + + + +
+ Date: +
+ 		+ (yyyy-mm-dd) +
+ Description: +
+ 		+ +
+ +

+
+ + +
+Previous Visits: + + + + + + + + + + + + + +
DateDescription
${visit.description}
+ +<%@ include file="/WEB-INF/jsp/footer.jsp" %> diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/welcome.jsp b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/welcome.jsp new file mode 100644 index 00000000000..d5072b70ba2 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/jsp/welcome.jsp @@ -0,0 +1,16 @@ +<%@ include file="/WEB-INF/jsp/includes.jsp" %> +<%@ include file="/WEB-INF/jsp/header.jsp" %> + + +

+ + + +

 

+ +<%@ include file="/WEB-INF/jsp/footer.jsp" %> diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/petclinic-servlet.xml b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/petclinic-servlet.xml new file mode 100644 index 00000000000..b7e8816ef6a --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/petclinic-servlet.xml @@ -0,0 +1,68 @@ + + + + + + + + + + + + + + + + + + + + + dataAccessFailure + dataAccessFailure + + + + + + + + + + + diff --git a/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/web.xml b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/web.xml new file mode 100644 index 00000000000..da45f51f560 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/WEB-INF/web.xml @@ -0,0 +1,143 @@ + + + + Spring PetClinic + + Spring PetClinic sample application + + + + webAppRootKey + petclinic.root + + + + + log4jConfigLocation + /WEB-INF/classes/log4j.properties + + + + + contextConfigLocation + + /WEB-INF/applicationContext-jdbc.xml + + + + + + + + + + + + org.springframework.web.context.ContextLoaderListener + + + + + petclinic + org.springframework.web.servlet.DispatcherServlet + 2 + + + + + petclinic + *.do + + + + 10 + + + + + index.jsp + + + + java.lang.Exception + + /WEB-INF/jsp/uncaughtException.jsp + + + + + + diff --git a/org.springframework.samples.petclinic/src/main/webapp/html/petclinic.html b/org.springframework.samples.petclinic/src/main/webapp/html/petclinic.html new file mode 100644 index 00000000000..91bd57e13c8 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/html/petclinic.html @@ -0,0 +1,1182 @@ + + + + The Spring PetClinic Application + + + + + + +
+ +

The Spring PetClinic Application

+ + + + + + +
Updated:21.OCT.2007Sam Brannen
30.JUN.2006Costin Leau
01.DEC.2004Ken Krebs
16.AUG.2003Ken Krebs
+ + + +

Introduction

+ +

+ The Spring Framework is a collection of small, well-focused, loosely coupled Java + frameworks that can be used independently or collectively to build + industrial strength applications of many different types. The PetClinic + sample application is designed to show how the Spring + application frameworks can be used to build simple, but powerful + database-oriented applications. It will demonstrate the use + of Spring's core functionality: +

+ +
    +
  • JavaBeans based application configuration using Inversion-Of-Control
    • +
  • Model-View-Controller web Presentation Layer
    • +
  • Practical database access through JDBC, Hibernate, or Java Persistence API
    • +
  • Application monitoring based on JMX
    • +
  • Declarative Transaction Management using AOP
    • +
  • Data Validation that supports but is not dependent on the Presentation Layer
    • +
+ +

+ The Spring frameworks provide a great deal of useful infrastructure to + simplify the tasks faced by application developers. This infrastructure + helps developers to create applications that are: +

+ +
    +
  • + concise + by handling a lot of the complex control flow that is needed to use the + Java API's, such as JDBC, JNDI, JTA, RMI, and EJB. +
    • +
  • + flexible + by simplifying the process of external application configuration + through the use of Reflection and JavaBeans. This allows the developer to + achieve a clean separation of configuration data from application code. + All application and web application objects, including validators, + workflow controllers, and views, are JavaBeans that can be configured + externally.
    • +
  • + testable + by supplying an interface based design to maximize pluggability. This + facilitates unit testing of Business Logic without requiring the + presence of application or live database servers.
    • +
  • + maintainable + by facilitating a clean separation of the application layers. It most + importantly helps maintain the independence of the Business Layer + from the Presentation layer. PetClinic demonstrates the use of a + Model-View-Controller + based web presentation framework that can work seamlessly with many + different types of view technologies. The Spring web application + framework helps developers to implement their Presentation as a clean + and thin layer focused on its main missions of translating user actions + into application events and rendering model data.
    • +
+ +

+ It is assumed that users of this tutorial will have a basic knowledge + of object-oriented design, Java, Servlets, JSP, and relational + databases. It also assumes a basic knowledge of the use of a Java EE web + application container. +

+ +

+ Since the purpose of the sample application is tutorial in nature, the + implementation presented here will of course provide only a small + subset of the functionality that would be needed by a real world version of a + PetClinic application. +

+ + +

PetClinic Sample Application Requirements

+ +

+ The application requirement is for an information system that is + accessible through a web browser. The users of the application are + employees of the clinic who in the course of their work need to view + and manage information regarding the veterinarians, the clients, and their + pets. The sample application supports the following: +

+ +

Use Cases

+
    +
  • View a list of veterinarians and their specialties
    • +
  • View information pertaining to a pet owner
    • +
  • Update the information pertaining to a pet owner
    • +
  • Add a new pet owner to the system
    • +
  • View information pertaining to a pet
    • +
  • Update the information pertaining to a pet
    • +
  • Add a new pet to the system
    • +
  • View information pertaining to a pet's visitation history
    • +
  • Add information pertaining to a visit to the pet's visitation history
    • +
+ +

Business Rules

+
    +
  1. An owner may not have multiple pets with the same case-insensitive name.
    2. +
+ + +

PetClinic Sample Application Design & Implementation

+ +

Server Technology

+

+ The sample application should be usable with any Java EE web application + container that is compatible with the Servlet 2.4 and JSP 2.0 + specifications. Some of the deployment files provided are designed + specifically for Apache Tomcat. These files specify container-supplied + connection-pooled data sources. It is not necessary to use these files. + The application has been configured by default to use a data source + without connection pooling to simplify usage. Configuration details are + provided in the Developer Instructions section. The view technologies + that are to be used for rendering the application are Java Server Pages + (JSP) along with the Java Standard Tag Library (JSTL). +

+ +

Database Technology

+

+ The sample application uses a relational database for data storage. + Support has been provided for a choice of 1 of 2 database selections, + MySql or HypersonicSQL. HypersonicSQL version 1.8.0 is the default + choice and a copy is provided with the application. It is possible to + easily configure the application to use either database. Configuration + details are provided in the Developer Instructions section. +

+ +

Development Environment

+

+ A copy of the Spring runtime library jar file is provided with the + sample application along with some of the other required jar files. The + developer will need to obtain the following tools externally, all of + which are freely available: +

+ +
    +
  • Java SDK 1.5.x
    • +
  • Ant 1.7.x
    • +
  • Tomcat 5.x.x, or some other web application container
    • +
  • JUnit 4.4 - needed to run the tests
    • +
  • (Optional) MySQL 5.x with MySQL Connector/J 5.x
    • +
+ +

+ NOTE: The version numbers listed are those that were used + in the development of the PetClinic application. Other versions of the same + tools may or may not work. +

+ +

+ Download links for the various tools needed are provided in the Developer + Instructions section. +

+ +

PetClinic Database

+

+ The following is an overview of the database schema used in PetClinic. + Detailed field descriptions can be found in the + "initDB.txt" + SQL script files in the database-specific "db" sub-directories. All "id" key + fields are of Java type int. +

+ +

+ TABLE: owners
+     PRIMARY KEY id +

+ +

+ TABLE: types
+     PRIMARY KEY id +

+ +

+ TABLE: pets
+     PRIMARY KEY id
+     FOREIGN KEY type_id + references the types + table id field
+     FOREIGN KEY owner_id + references the owners + table id field +

+ +

+ TABLE: vets
+     PRIMARY KEY id +

+ +

+ TABLE: specialties
+     PRIMARY KEY id
+

+ +

+ TABLE: vet_specialties - + a link table for vets + and their specialties
+     FOREIGN KEY vet_id + references the vets + table id field
+     FOREIGN KEY specialty_id + references the specialties + table id field +

+ +

+ TABLE: visits
+     PRIMARY KEY id
+     FOREIGN KEY pet_id + references the pets + table id field +

+ +

Directory Structure

+ +

+ d-- indicates a directory holding source code, configuration files, etc.
+ D-- indicates a directory that is created by the build script +

+ +

+ d-- petclinic: + the root directory of the project contains build related files
+ +     d-- src: contains + Java source code files and ORM configuration files
+ +     d-- war: contains + the web application resource files
+ +         d-- html: contains + tutorial files
+ +         D-- docs: contains + Javadoc files
+ +         d-- web-inf: + contains web application configuration files and application context + files
+ +               + d-- jsp: + contains Java Server Page files
+ +               + D-- lib: + contains application dependencies
+ +     d-- test: contains + testing related + Java source code files
+ +     d-- db: contains + database SQL scripts and other related files/directories
+ +         d-- hsqldb: + contains files related to HSQL, contains scripts and a Tomcat + context definition file
+ +         d-- mysql: + contains files related to MySQL, contains scripts and a Tomcat context + definition file
+ +     D-- .classes: + contains compiled Java class files
+ +     D-- .testclasses: + contains compiled testing related Java class files
+ +     D-- junit-reports: + contains generated xml-formatted test reports
+ +          D-- reports/html: + contains generated html-formatted test reports
+ +     D-- dist: contains + packaged archives of files +

+ + +

PetClinic Application Design

+ +

Logging

+

+ Spring supports the use of the Apache Commons Logging API. This API + provides the ability to use Java 1.4 loggers, the simple Commons loggers, + and Apache Log4J loggers. PetClinic uses Log4J to provide sophisticated + and configurable logging capabilities. The file, + war/WEB-INF/log4j.properties + configures the definition of Log4jloggers. +

+ +

Business Layer

+

+ The Business Layer consists of a number of basic JavaBean classes + representing the application domain objects and associated validation + objects that are used by the Presentation Layer. The validation objects + used in PetClinic are all implementations of the + org.springframework.validation.Validator interface. +

+ +
    +
  • org.springframework.samples.petclinic.Entity + is a simple JavaBean superclass used for all persistable objects.
    • +
  • org.springframework.samples.petclinic.NamedEntity + is an extension of Entity that adds a name property.
    • +
  • org.springframework.samples.petclinic.Specialty + is an extension of NamedEntity.
    • +
  • org.springframework.samples.petclinic.PetType + is an extension of NamedEntity.
    • +
  • org.springframework.samples.petclinic.Person is + an extension of Entity that provides a superclass for all objects that + implement the notion of a person.
    • +
  • org.springframework.samples.petclinic.Vet is + an extension of Person that implements a + veterinarian. It holds a List of + specialties that the Vet is capable of.
    • +
  • org.springframework.samples.petclinic.Owner + is an extension of Person that implements a pet owner. + It holds a List of pets owned.
    • +
  • org.springframework.samples.petclinic.Pet + is an extension of NamedEntity that + implements a pet. It holds a List of + visits made concerning the pet.
    • +
  • org.springframework.samples.petclinic.Visit + is a simple JavaBean that implements the notion of a clinic visit + for a pet.
    • +
  • org.springframework.samples.petclinic.util.EntityUtils + provides utility methods for handling entities.
    • +
+ +
    +
  • org.springframework.samples.petclinic.validation.OwnerValidator + is a Spring Validator that + verifies correct data entry for the Add and Edit Owner forms.
    • +
  • org.springframework.samples.petclinic.validation.PetValidator + is a Spring Validator that + verifies correct data entry for the Add and Edit Pet forms.
    • +
  • org.springframework.samples.petclinic.validation.VisitValidator + is a Spring Validator that + verifies correct data entry for the AddVisit form.
    • +
+ +

Business / Persistence Layer

+ +

+ Since the PetClinic application is all about database access and there is + very little business logic in the application outside of that, there is + no separation of the primary Business and Persistence Layer API's. + While this design technique should not be used for an application with more + complex business logic, it is acceptable here because all of the + non-persistence related business rules have been implemented in + business objects and have not leaked into the Persistence Layer. The most + important facet of the design is that the Business and Persistence + Layers are COMPLETELY independent of the Presentation Layer. +

+ +

+ The Persistence Layer can be configured to use either HSQL or MySQL + with any one of the following data access technologies aided by + infrastructure provided by Spring: +

+ +
    +
  • JDBC
    • +
  • Hibernate 3
    • +
  • Java Persistence API
    • +
+ +

+ NOTE: Spring also provides + infrastructure for using other + Object/Relational Mapping + frameworks such as JDO and iBATIS SqlMaps, but these are not demonstrated in PetClinic. + (See the 'jpetstore' sample application that ships with the full Spring Framework + distribution for an example of using iBatis and Spring.) +

+ +

+ One of the key elements provided by Spring is the use of a common set + of meaningful data access exceptions that can be used regardless of + which database or access strategy is used. All of these exceptions + derive from org.springframework.dao.DataAccessException. + Since most exceptions encountered during database access are indicative + of programming errors, DataAccessException is an + abstract RuntimeException whose derivatives only need + to be caught by application code to handle recoverable errors when it + makes sense to do so. This greatly simplifies application code compared + to, for example, code using JDBC directly where SqlExceptions + must be caught and database specific error codes must be decoded. + Examination of the PetClinic source code will show that the + persistence-oriented code is completely focused on the relevant + transfer of data to/from the referenced objects without extraneous + error handling. +

+ +

+ The high-level business/persistence API for PetClinic is the + org.springframework.samples.petclinic.Clinic + interface. Each persistence strategy in PetClinic is a different implementation of the + Clinic interface. In each case, the + Clinic implementation is fronted by + a transactional proxy, configured via the + @Transactional annotation, that also + implements Clinic. These objects + are standard Java dynamic proxies which are created by an instance of + org.springframework.transaction.interceptor.TransactionProxyFactoryBean. + These proxies are configured in the respective application context file + via <tx:annotation-driven /> and specify that all + Clinic methods are run in a + transactional context. The transaction managers used in PetClinic are all + implementations of the + org.springframework.transaction.PlatformTransactionManager + interface. All of the implementations are by default configured + to use a local DataSource that + will work in any environment through the use of an instance of + org.springframework.jdbc.datasource.DriverManagerDataSource. + While this is appropriate for use in a demo or single user + program, a connection pooling DataSource, + such as an instance of org.apache.commons.dbcp.BasicDataSource, + is more appropriate for use in a multi-user application. Another + alternative is to obtain one through the Java EE environment + using an instance of + org.springframework.jndi.JndiObjectFactoryBean. +

+ +

JDBC Clinic Implementation

+

+ Spring provides a number of high-level database + access convenience classes in the package + org.springframework.jdbc.object. + These classes and the lower-level Spring classes that they use in the + org.springframework.jdbc.core package + provide a higher level of abstraction for using JDBC that keeps the developer + from having to correctly implement the handling of the checked + SqlExceptions with ugly error-prone + nested try-catch-finally blocks. Using the classes in this package + allows the developer to focus efforts on the functionality being + implemented rather than the mechanics of error handling. When using + these classes, it is the responsibility of the developer to provide the + SQL needed and to map the parameters to/from the respective domain + object. This typically is done by extending one of the + org.springframework.jdbc.object classes, + initializing its SQL, and overriding a method that takes care of + the mapping. In this way, the developer gets to focus on implementing + functionality rather than application plumbing. These classes also + take care of closing connections to prevent hard to find resource + leakage problems. It should be noted that instances of these classes + are lightweight, reusable, and threadsafe. +

+ +

+ The JDBC implementation of the Clinic interface is + org.springframework.samples.petclinic.jdbc.SimpleJdbcClinic, + which uses Java 5 language features, + org.springframework.jdbc.core.simple.SimpleJdbcTemplate, and + org.springframework.jdbc.core.simple.SimpleJdbcInsert. + It also takes advantage of classes like + org.springframework.jdbc.core.namedparam.BeanPropertySqlParameterSource and + org.springframework.jdbc.core.simple.ParameterizedBeanPropertyRowMapper + which provide automatic mapping between JavaBean properties and JDBC + parameters or query results. SimpleJdbcClinic is a rewrite of the + AbstractJdbcClinic which was the base class for JDBC implementations of + the Clinic interface for Spring 2.0. +

+ +

+ The transaction manager used in the JDBC Clinic Implementation is an + instance of org.springframework.jdbc.datasource.DataSourceTransactionManager + that can be used for local transactions. +

+ +

Hibernate 3 Clinic Implementation

+

+ The Hibernate 3 implementation of the Clinic + interface is + org.springframework.samples.petclinic.hibernate.HibernateClinic. + To simplify using Hibernate, Spring provides the + org.springframework.orm.hibernate3.LocalSessionFactoryBean. + The Hibernate configuration is provided by the file src/petclinic.hbm.xml. +

+ +

Java Persistence API (JPA) Clinic Implementation

+

+ The JPA implementation of the Clinic + interface is + org.springframework.samples.petclinic.jpa.EntityManagerClinic, + which is based on native JPA usage combined with Spring's + @Repository and + @Transactional annotations but + otherwise has no dependencies on any Spring API's. + To simplify JPA usage, Spring provides (among other classes) the + org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean. + The JPA configuration is provided by + src/META-INF/orm.xml and + src/META-INF/persistence.xml. +

+ +

ApplicationContext

+

+ A Spring org.springframework.context.ApplicationContext object + provides a map of user-defined JavaBeans that specify either a singleton + object or the initial construction of prototype instances. These beans + constitute the Business/Persistence + Layer of PetClinic. The following beans are defined in all 3 + versions (1 per access strategy) of the PetClinic + war/WEB-INF/applicationContext-*.xml + file: +

+ +
    +
  1. A PropertyPlaceholderConfigurer, + which is configured via + <context:property-placeholder ... /> and + is a singleton bean that replaces ${...} placeholders with values from a + properties file, in this case, JDBC-related settings for the + dataSource bean + described below + (see src/jdbc.properties). +
    2. +
  2. dataSource, + which is a singleton bean that defines the implementation of the source + of database connections used by the application. +
    3. +
  3. transactionManager, + which is a singleton bean that defines the implementation of the transaction + management strategy for the application. +
    4. +
  4. clinic, + which is a singleton bean that defines the implementation of the + Clinic interface that provides the + primary Business Layer API of the application. +
    5. +
+ +

Presentation Layer

+

+ The Presentation Layer is implemented as a Java EE Web Application and + provides a very thin and concise Model-View-Controller type user + interface to the Business and Persistence Layers. +

+ +

+ The PetClinic web application is configured via the following files: +

+ +
    +
  • war/WEB-INF/web.xml: + the web application configuration file.
    • +
  • war/WEB-INF/petclinic-servlet.xml: + configures the petclinic dispatcher servlet and the other controllers + and forms that it uses. The beans defined in this file reference the + Business/Persistence Layer beans defined in + applicationContext-*.xml.
    • +
  • war/WEB-INF/classes/messages*.properties: + configures the definition of internationalizable message resources.
    • +
+ +

+ Examine the comments provided in each of these files for a more + in-depth understanding of the details of how the application is + configured. +

+ +

General

+ +
    +
  • In web.xml, + a context-param, "webAppRootkey", + provides the key for a system property that specifies the root directory + for the web application. This parameter, + "petclinic.root", can be used to aid + in configuring the application.
    • +
  • In web.xml, + a org.springframework.web.context.ContextLoaderListener + is defined that loads the root ApplicationContext + object of this webapp at startup, by default from the designated + /WEB-INF/applicationContext-*.xml. + The root org.springframework.web.context.WebApplicationContext + of PetClinic is an instance of + org.springframework.web.context.support.XmlWebApplicationContext + and is the parent of all servlet-specific ApplicationContexts. + The Spring root ApplicationContext object + provides a map of user-defined JavaBeans that can be used in any and + all layers of the application. Beans defined in the root + ApplicationContext are automatically + available in all child ApplicationContext + objects as (external) bean references. Beans defined in an + ApplicationContext can also be + accessed directly by Java code through + getBean(name) method calls. +
    • + +
  • In web.xml, + a Servlet named + "petclinic" is specified to act as + a dispatcher for the entire application. This + org.springframework.web.servlet.DispatcherServlet + is used to handle all URL's matching the pattern "*.do". + As with any Servlet, multiple URL mappings may + be defined. It is also possible to define multiple instances of + DispatcherServlet. Each + DispatcherServlet dispatches + requests to registered handlers (Controller + interface implementations or POJOs annotated with @Controller) + indirectly through a + org.springframework.web.servlet.handler.HandlerMapping + implementation. Each DispatcherServlet + has its own ApplicationContext, + by default defined in "{servlet-name}-servlet.xml". + In this case, it is in the file "petclinic-servlet.xml". + This ApplicationContext is + used to specify the various web application user interface beans and + the URL mappings that are used by the DispatcherServlet + to control the handling of requests. +
    • +
+ +

+ The files web.xml and + log4j.properties specify + the configuration of logging in the system: +

+ +
    +
  • In web.xml, + a "log4jConfigLocation" context-param + is specified that sets the location of the + Log4j configuration file. The + default location for this file is + /WEB-INF/classes/log4j.properties. + Specifying this parameter explicitly allows the location to be changed + from the default and is also used to cause periodic + Log4j configuration refresh checks.
    • +
  • In web.xml, + a Log4jConfigListener is + specified that will initialize Log4j using + the specified configuration file when the web app starts. The + Log4jConfigListener is commented out + in the file because of a conflict when using JBoss. It should also be + noted that if the container initializes Servlets before Listeners as + some pre-Servlet 2.4 containers do, a Log4jConfigServlet should + be used instead.
    • +
  • In log4j.properties, + the following loggers are specified: +
      +
    • "stdout" provides + logging messages to the container's log file.
      • +
    • "logfile" provides + logging messages to a rolling file that is specified using the + previously defined "petclinic.root".
      • +
    +
    • +
+ +

+ Examination and study of these logging files will provide insight into + the operation of the Spring framework and the application as well as + valuable troubleshooting information should something not work + correctly. +

+ +

DispatcherServlet

+

+ The following beans are accessible to the + DispatcherServlet and are defined + in the PetClinic + petclinic-servlet.xml + file. This dispatcher uses these definitions to delegate actual display + and form processing tasks to implementations of the Spring + org.springframework.web.servlet.mvc.Controller + interface. The DispatcherServlet + acts as the main application Front Controller + and is responsible for dispatching all requests to the appropriate + Controller indirectly through a URL + mapping handler. These Controllers are + responsible for the mechanics of interaction with the user and ultimately + delegate action to the Business/Persistence Layers. +

+ +
    +
  • + messageSource + is a singleton bean that defines a message source for this + ApplicationContext. Messages are + loaded from localized "messages_xx" + files in the classpath, such as + "/WEB-INF/classes/messages.properties" + or "/WEB-INF/classes/messages_de.properties". + getMessage() calls to this context + will use this source. Child contexts can have their own message sources, + which will inherit all messages from this source and are able to define new + messages and override ones defined in the primary message source. +
    • +
  • + InternalResourceViewResolver + is a singleton bean that defines the view mappings used by the dispatcher. + Specifically, logical view names returned by Controllers will be mapped to + physical paths using the configured 'prefix' and 'suffix' properties. For + example, a logical view name of "vets" will be mapped to "/WEB-INF/jsp/vets.jsp". +
    • +
  • + SimpleMappingExceptionResolver + is a singleton bean that defines how exceptions are propagated. Exceptions + encountered that are not specified are propagated to the servlet container. +
    • +
  • + <context:component-scan ... /> + is used to autodetect the controllers in the + org.springframework.samples.petclinic.web package, which + are POJOs labeled with the @Controller annotation. +
      +
    • + ClinicController is a singleton, annotation-driven + MultiActionController that is used by the dispatcher to handle + non-form based display tasks. A method is provided to handle each + type of request that is supported. +
      • +
    • + In addition, there are 6 singleton, annotation-driven Form controllers, + which are used to handle the various Search, Add and Edit form processing + tasks for the dispatcher. +
      • +
    +
    • +
  • + The form-based controllers within the PetClinic application provide + @RequestMapping annotations at the type level for path + mapping URLs and @RequestMapping at the method level for request type + mappings (e.g., GET and POST). In contrast, ClinicController + – which is not form-based – provides @RequestMapping only at + the method level for path mapping URLs. + DefaultAnnotationHandlerMapping is driven by these + annotations and is enabled by default with Java 5+. +
    • +
+ +

Views

+

+ The Controllers used by the + dispatcher handle the work flow of the application. The actual display + tasks are delegated by the Controllers + to implementations of the Spring View + interface. These View objects are + themselves beans that can render a particular type of view. The + handling Controller supplies the + View with a data model to render. + The data model is provided to the View + as a Map of objects. + Views are only responsible for + rendering a display of the data model and performing any display logic + that is particular to the type of View + being rendered. Spring provides support for rendering many different types of + views: JSP, XSLT, PDF, Velocity templates, Excel files, and others. By + using a View mapping strategy, + Spring supplies the developer with a great deal of flexibility in supporting + easily configurable view substitution. +

+

+ ClinicController relies on + RequestToViewNameTranslator to automatically infer the + logical view name from the incoming request URL; whereas, all Form + controllers in the PetClinic application return logical view names as Strings. + These logical view names are then mapped to physical paths via the + configured InternalResourceViewResolver (see the + DispatcherServlet section above for further details). Logical view names that + are prepended with "redirect:" will be resolved to instances + of RedirectView, which simply redirects to another URL. + The other resolved Views will be instances of + JstlView, which provides some handy support for + internationalization & localization in JSP pages that use JSTL. +

+ +

Messages

+

+ The messages*.properties + files are loaded from the classpath to provide localized messages for + the supported languages. PetClinic supplies a localized + "welcome" message as well as localized form entry error + messages in the default (i.e., English) and German properties files. + See the "countries" sample application for a more detailed example of Spring's + support for internationalization. +

+ +

Presentation Layer classes

+
    +
  • + org.springframework.samples.petclinic.web.ClinicController + is an annotation-driven, POJO MultiActionController + that is used to handle simple display-oriented URLs. +
    • +
  • + org.springframework.samples.petclinic.web.FindOwnersForm + is an annotation-driven, POJO Form controller that is used to search for + Owners by last name. +
    • +
  • + org.springframework.samples.petclinic.web.AddOwnerForm + is an annotation-driven, POJO Form controller that is used to add a new Owner + to the system. +
    • +
  • + org.springframework.samples.petclinic.web.EditOwnerForm + is an annotation-driven, POJO Form controller that is used to edit an existing Owner. + A copy of the existing Owner is used for editing. +
    • +
  • + org.springframework.samples.petclinic.web.AddPetForm + is an annotation-driven, POJO Form controller that is used to add a new Pet + to an existing Owner. +
    • +
  • + org.springframework.samples.petclinic.web.EditPetForm + is an annotation-driven, POJO Form controller that is used to edit an existing Pet. + A copy of the existing Pet is used for editing. +
    • +
  • + org.springframework.samples.petclinic.web.AddVisitForm + is an annotation-driven, POJO Form controller that is used to add a new Visit + to an existing Pet. +
    • +
+ +

Logical Views & Implemented Use Cases

+ +
    +
  • welcome is + the "home" screen. It provides links to display a list of all vets, + find an owner, or view documentation.
    • +
  • vets displays + all vets and their specialties.
    • +
  • findOwners + is used to find owners by last name.
    • +
  • findOwnersRedirect + redirects to findOwner.
    • +
  • selectOwner + allows user to select from a list of multiple owners with the same last + name.
    • +
  • owner displays + a owner's data and a list of the owner's pets and their data.
    • +
  • ownerRedirect + redirects to owner.
    • +
  • owner supports + AddOwnerForm + and EditOwnerForm
    • +
  • pet supports + AddPetForm + and web.EditPetForm
    • +
  • visit supports + AddVisitForm
    • +
  • dataAccessFailure + displays a stacktrace
    • +
+ +

Java Server Pages

+ +
    +
  • index.jsp + redirects to the "welcome" page.
    • +
  • includes.jsp is + statically included in all + JSP's used in the application. It specifies the taglibs that are in use.
    • +
  • header.jsp and + footer.jsp + display info common to virtually all pages. Spring also supplies + support for the integration of Tiles + (included in Struts) but this is not used in PetClinic.
    • +
  • dataAccessFailure.jsp + is the error page configured via + SimpleMappingExceptionResolver, + which displays a stack trace and normally wouldn't be used in a production + version of an application. It can be seen in action by entering a URL of + "editOwner.do" or "editPet.do" with an invalid request parameter, for example: + /petclinic/owner.do?ownerId=-1. + The handlers for these URLs normally expect to see a respective "ownerId" or "petId" + request parameter corresponding to an Owner or Pet in the database. Thus, + these handlers will throw a DataAccessException when such + a request parameter is provided which references a non-existing entity.
    • +
  • uncaughtException.jsp + is the web.xml configured + "error-page". It displays a stack trace and normally wouldn't be used + in a production version of an application. It can be seen in action by + entering a URL of "editOwner.do" or "editPet.do" without a valid request + parameter, for example: + /petclinic/owner.do. + The handlers for these URLs normally expect to see a respective "ownerId" or "petId" + request parameter and throw a ServletException when such + a request parameter is not found.
    • +
  • welcome.jsp implements + welcome.
    • +
  • vets.jsp implements + vets.
    • +
  • findOwners.jsp implements + findOwners.
    • +
  • owners.jsp implements + selectOwner.
    • +
  • owner.jsp implements + owner.
    • +
  • ownerForm.jsp implements + ownerForm.
    • +
  • petForm.jsp implements + petForm.
    • +
  • visitForm.jsp implements + visitForm.
    • +
+ +

+ The following items should be noted regarding the web application + implementation design: +

+ +
    +
  1. all JSP's are stored under /WEB-INF/jsp except + for index.jsp which + is the configured "welcome-file"
    2. +
  2. The use of JSP technology in the application is not exposed to + the user, i.e., the end user never sees a URL ending in + ".jsp".
    3. +
  3. By convention, all URL's in the application ending in + ".do" are + handled by web application controllers. Static html pages ending in + ".html", such as + Javadoc, will be directly served to the end user.
    4. +
  4. The results of all form entries are handled using browser round + trip redirection to minimize possible end user confusion.
    5. +
  5. All pages are extremely simple JSP implementations that focus + only on providing the necessary functionality.
    6. +
  6. References to Entity objects + are passed around in the application by supplying the object's ID + as a request parameter.
    7. +
+ +

Testing

+
    +
  • org.springframework.samples.petclinic.OwnerTests + is a simple JUnit 4 based TestCase that supports Business Rule #1.
    • +
  • org.springframework.samples.petclinic.AbstractClinicTests + is a JUnit 4 based TestCase requiring a live database connection that is + used to confirm correct operation of the database access objects in the + various implementations of the Clinic interface. + "AbstractClinicTests-context.xml" declares a common + javax.sql.DataSource. Subclasses specify additional + context locations which declare a + org.springframework.transaction.PlatformTransactionManager + and a concrete implementation of Clinic. +

    + AbstractClinicTests extends + AbstractTransactionalJUnit4SpringContextTests, + one of the valuable testing support classes provided by the + Spring TestContext Framework found in the + org.springframework.test.context package. The + annotation-driven configuration used here represents best practice for + integration tests with Spring. Note, however, that + AbstractTransactionalJUnit4SpringContextTests serves only as a convenience + for extension. For example, if you do not wish for your test classes to be + tied to a Spring-specific class hierarchy, you may configure your tests with + annotations such as @ContextConfiguration, + @TestExecutionListeners, @Transactional, etc. +

    +

    + AbstractClinicTests and its subclasses benefit from the following services + provided by the Spring TestContext Framework: +

    +
      +
    • Spring IoC container caching which spares us + unnecessary set up time between test execution.
      • +
    • Dependency Injection of test fixture instances, + meaning that we don't need to perform application context lookups. See the + use of @Autowired on the clinic instance + variable, which uses autowiring by type. As an alternative, we + could annotate clinic with JSR 250's + @Resource to achieve dependency injection by name. + (see: @ContextConfiguration, + DependencyInjectionTestExecutionListener)
      • +
    • Transaction management, meaning each test method is + executed in its own transaction, which is automatically rolled back by + default. Thus, even if tests insert or otherwise change database state, there + is no need for a teardown or cleanup script. + (see: @TransactionConfiguration, + @Transactional, TransactionalTestExecutionListener)
      • +
    • Useful inherited protected fields, such as a + SimpleJdbcTemplate that can be used to verify + database state after test operations or to verify the results of + queries performed by application code. An + ApplicationContext is also inherited and can be + used for explicit bean lookup if necessary. + (see: AbstractJUnit4SpringContextTests, + AbstractTransactionalJUnit4SpringContextTests)
      • +
    +

    + The Spring TestContext Framework and related unit and + integration testing support classes are shipped in + spring-test.jar. +

    + +
    • +
+ +

Downloads

+
    +
  • Download and install the + Spring Framework + (examples, including PetClinic are provided)
    • +
  • Download and install a Java + Software Developer Kit, version 1.5 or later
    • +
  • Download and install Apache Ant, + preferably version 1.7.0 or later
    • +
  • Download and install JUnit, + preferably version 4.4 or later
    • +
  • Download and install Apache Tomcat, + preferably version 5.5.x or later
    • +
  • Download and install MySQL, + preferably version 5.0.x or later (optional)
    • +
  • Hypersonic SQL, and + Hibernate are provided with the + application.
    • +
  • PetClinic and Spring use the Apache + Commons Logging + and Log4J + packages
    • +
+ +

Ant Setup

+

+ Make sure that the Ant executable is in your command shell path. Ant + will need to reference classes from JUnit + and the database(s) of interest. Place a copy of any needed jar files in + Ant's /lib directory, i.e.: +

+ +
    +
  • JUnit - junit.jar
    • +
  • HSQL - hsqldb.jar
    • +
  • MYSQL - mysql-connector-java-5.1.5-bin.jar or other
    • +
+ +

HSQL Setup

+

+ Create a new directory containing a copy of the entire contents of + the directory petclinic/db/hsqldb. + The file petclinic.script + is the data file that will be used by the server. It has been + initialized with some sample data. Start a server on the standard port + by executing server.sh(Unix) + or server.bat (Windows) + or alternatively edit the file to select a port of your choosing. + A useful database manager can be started by executing + manager.sh (Unix) + or manager.bat (Windows). + When the application opens, connect to the "HSQL Database Engine + Server" using the default parameters. This tool can also be used to + manage other databases. To use a different port, it will be necessary + to change the PetClinic Database Setup. It may also be necessary to + consult the HSQL documentation for instructions on how to change the port + the server uses. +

+ +

MYSQL Setup (optional)

+

+ Add the PetClinic database to a running MySQL server by following the + explicit instructions found in + db/mysql/petclinic_db_setup_mysql.txt. + PetClinic expects by default to be able to access the server via the + standard port 3306. To use a different port, it will be + necessary to change the PetClinic Database Setup. +

+ +

PetClinic Database Setup

+

+ To use a Java EE server supplied connection-pooled data source with + Tomcat, it will be necessary to use and possibly edit the appropriate + context definition file for the petclinic webapp. To use it, deploy a + copy of the appropriate context definition file in Tomcat's webapps + directory and restart the server. Consult the Tomcat log files if + something goes wrong when starting either Tomcat or the PetClinic + application. The context files are named + petclinic_tomcat_*.xml, + where * is either "hsqldb" or "mysql". + There is a context file supplied for each + database in its respective directory. There is also a context file + db/petclinic_tomcat_all.xml + that will provide a JNDI connection-pooled DataSource for all supported + databases. Should you use this file, you must of course make sure that all the + database servers are running when you restart Tomcat. +

+ +

+ + NOTES: +

+ +
    +
  1. Should you deploy one of the context files or define a context in + Tomcat's server.xml, + Tomcat will not automatically deploy the webapp from the + petclinic.war file. + The webapp will then need to be manually extracted to the target + directory.
    2. +
  2. The context files will also configure logging to supply a + separate log file for the petclinic context. This will separate the + container logging for petclinic from that of the other webapps. This + should not be confused with the application log file provided through + Log4j.
    3. +
  3. An Ant script (db/build.xml) + has been provided that can be used to re-initialize either database. To + select or configure the data source and database used for the webapp and + for testing, you will need to edit the following files: +
      +
    • war/WEB-INF/applicationContext-*.xml: + for configuring the DataSource in the webapp
      • +
    • src/jdbc.properties: + for configuring JDBC connection settings for both the webapp and testing
      • +
    • build.properties: + for running the "tests" target in Ant
      • +
    +
    4. +
+ +

Building the PetClinic Application

+

+ Open a command line shell and navigate to the directory containing + PetClinic and execute "ant". This will display a list of the Ant + targets that are available. Make sure the database is running and execute + "ant all". This will run the Ant "all" target which + will clean and compile everything, generate Javadoc, and execute the tests, + including a live test using the database. The other Ant targets provide + subsets of this functionality. +

+ +

Deploying the PetClinic Application

+

+ Deploy the web application to the server in the usual way (see + notes regarding database setup). If you need + instructions for web application deployment, see the Tomcat + documentation for details. The Web ARchive file is + petclinic.war + and can be found in the + dist directory. +

+ +

Using the PetClinic Application

+

+ Make sure the PetClinic web application is running and browse to + http://localhost:8080/petclinic. +

+ + + + + + +
Home
+
+ + + diff --git a/org.springframework.samples.petclinic/src/main/webapp/images/banner-graphic.png b/org.springframework.samples.petclinic/src/main/webapp/images/banner-graphic.png new file mode 100644 index 00000000000..e6d01d58852 Binary files /dev/null and b/org.springframework.samples.petclinic/src/main/webapp/images/banner-graphic.png differ diff --git a/org.springframework.samples.petclinic/src/main/webapp/images/bullet-arrow.png b/org.springframework.samples.petclinic/src/main/webapp/images/bullet-arrow.png new file mode 100644 index 00000000000..5909c25b397 Binary files /dev/null and b/org.springframework.samples.petclinic/src/main/webapp/images/bullet-arrow.png differ diff --git a/org.springframework.samples.petclinic/src/main/webapp/images/pets.png b/org.springframework.samples.petclinic/src/main/webapp/images/pets.png new file mode 100644 index 00000000000..0fe63c282b1 Binary files /dev/null and b/org.springframework.samples.petclinic/src/main/webapp/images/pets.png differ diff --git a/org.springframework.samples.petclinic/src/main/webapp/images/springsource-logo.png b/org.springframework.samples.petclinic/src/main/webapp/images/springsource-logo.png new file mode 100644 index 00000000000..e170f8abf77 Binary files /dev/null and b/org.springframework.samples.petclinic/src/main/webapp/images/springsource-logo.png differ diff --git a/org.springframework.samples.petclinic/src/main/webapp/images/submit-bg.png b/org.springframework.samples.petclinic/src/main/webapp/images/submit-bg.png new file mode 100644 index 00000000000..10a94371b64 Binary files /dev/null and b/org.springframework.samples.petclinic/src/main/webapp/images/submit-bg.png differ diff --git a/org.springframework.samples.petclinic/src/main/webapp/index.jsp b/org.springframework.samples.petclinic/src/main/webapp/index.jsp new file mode 100644 index 00000000000..b1bf425fc0c --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/index.jsp @@ -0,0 +1,5 @@ +<%@ include file="/WEB-INF/jsp/includes.jsp" %> + +<%-- Redirected because we can't set the welcome page to a virtual URL. --%> + + diff --git a/org.springframework.samples.petclinic/src/main/webapp/styles/petclinic.css b/org.springframework.samples.petclinic/src/main/webapp/styles/petclinic.css new file mode 100644 index 00000000000..d0841b2baa9 --- /dev/null +++ b/org.springframework.samples.petclinic/src/main/webapp/styles/petclinic.css @@ -0,0 +1,234 @@ +/* main elements */ + +body,div,td { + font-family: Arial, Helvetica, sans-serif; + font-size: 12px; + color: #666; +} + +body { + background-color: #fff; + background-image: url(../images/banner-graphic.png); + background-position: top center; + background-repeat: no-repeat; + text-align: center; + min-width: 600px; + margin-top: 60px; + margin-left: auto; + margin-right: auto; +} + +div { + margin: 5px 25px 5px 25px; + text-align: left; +} + +/* header and footer elements */ + +#main { + margin:0 auto; + position:relative; + top: 35px; + left:0px; + width:560px; + text-align:left; +} + +.footer { + background:#fff; + border:none; + margin-top:20px; + border-top:1px solid #999999; + width:100%; +} + +.footer td {color:#999999;} + +.footer a:link {color: #7db223;} + + +/* text styles */ + +h1,h2,h3 { + font-family: Helvetica, sans-serif; + color: #7db223; +} + +h1 { + font-size: 20px; + line-height: 26px; +} + +h2 { + font-size: 18px; + line-height: 24px; +} + +h3 { + font-size: 15px; + line-height: 21px; + color:#555; +} + +h4 { + font-size: 14px; + line-height: 20px; +} + +.errors { + color: red; + font-weight: bold; +} + +a { + text-decoration: underline; + font-size: 13px; +} + +a:link { + color: #7db223; +} + +a:hover { + color: #456314; +} + +a:active { + color: #7db223; +} + +a:visited { + color: #7db223; +} + +ul { + list-style: disc url(../images/bullet-arrow.png); +} + +li { + padding-top: 5px; + text-align: left; +} + +li ul { + list-style: square url(images/sub-bullet.gif); +} + +li ul li ul { + list-style: circle none; +} + +/* table elements */ + +table { + background: #d6e2c3; + margin: 3px 0 0 0; + border: 4px solid #d6e2c3; + border-collapse: collapse; +} + +table table { + margin: -5px 0; + border: 0px solid #e0e7d3; + width: 100%; +} + +table td,table th { + padding: 8px; +} + +table th { + font-size: 12px; + text-align: left; + font-weight: bold; +} + +table thead { + font-weight: bold; + font-style: italic; + background-color: #c2ceaf; +} + +table a:link {color: #303030;} + +caption { + caption-side: top; + width: auto; + text-align: left; + font-size: 12px; + color: #848f73; + padding-bottom: 4px; +} + +fieldset { + background: #e0e7d3; + padding: 8px; + padding-bottom: 22px; + border: none; + width: 560px; +} + +fieldset label { + width: 70px; + float: left; + margin-top: 1.7em; + margin-left: 20px; +} + +fieldset textfield { + margin: 3px; + height: 20px; + background: #e0e7d3; +} + +fieldset textarea { + margin: 3px; + height: 165px; + background: #e0e7d3; +} + +fieldset input { + margin: 3px; + height: 20px; + background: #e0e7d3; +} + +fieldset table { + width: 100%; +} + +fieldset th { + padding-left: 25px; +} + +.table-buttons { + background-color:#fff; + border:none; +} + +.table-buttons td { + border:none; +} + +.submit input { + background:url(../images/submit-bg.png) repeat-x; + border: 2px outset #d7b9c9; + color:#383838; + padding:2px 10px; + font-size:11px; + text-transform:uppercase; + font-weight:bold; +} + +.updated { + background:#ecf1e5; + font-size:11px; + margin-left:2px; + border:4px solid #ecf1e5; +} + +.updated td { + padding:2px 8px; + font-size:11px; + color:#888888; +} \ No newline at end of file diff --git a/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/AbstractClinicTests-context.xml b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/AbstractClinicTests-context.xml new file mode 100644 index 00000000000..60d51e3ff4c --- /dev/null +++ b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/AbstractClinicTests-context.xml @@ -0,0 +1,20 @@ + + + + + + + + + + + + diff --git a/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/AbstractClinicTests.java b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/AbstractClinicTests.java new file mode 100644 index 00000000000..a698691867a --- /dev/null +++ b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/AbstractClinicTests.java @@ -0,0 +1,224 @@ +package org.springframework.samples.petclinic; + +import java.util.Collection; +import java.util.Date; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; +import org.junit.Test; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.samples.petclinic.util.EntityUtils; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests; + +/** + *

+ * Base class for {@link Clinic} integration tests. + *

+ *

+ * "AbstractClinicTests-context.xml" declares a common + * {@link javax.sql.DataSource DataSource}. Subclasses should specify + * additional context locations which declare a + * {@link org.springframework.transaction.PlatformTransactionManager PlatformTransactionManager} + * and a concrete implementation of {@link Clinic}. + *

+ *

+ * This class extends {@link AbstractTransactionalJUnit4SpringContextTests}, + * one of the valuable testing support classes provided by the + * Spring TestContext Framework found in the + * org.springframework.test.context package. The + * annotation-driven configuration used here represents best practice for + * integration tests with Spring. Note, however, that + * AbstractTransactionalJUnit4SpringContextTests serves only as a convenience + * for extension. For example, if you do not wish for your test classes to be + * tied to a Spring-specific class hierarchy, you may configure your tests with + * annotations such as {@link ContextConfiguration @ContextConfiguration}, + * {@link org.springframework.test.context.TestExecutionListeners @TestExecutionListeners}, + * {@link org.springframework.transaction.annotation.Transactional @Transactional}, + * etc. + *

+ *

+ * AbstractClinicTests and its subclasses benefit from the following services + * provided by the Spring TestContext Framework: + *

+ *
    + *
  • Spring IoC container caching which spares us + * unnecessary set up time between test execution.
    • + *
  • Dependency Injection of test fixture instances, + * meaning that we don't need to perform application context lookups. See the + * use of {@link Autowired @Autowired} on the clinic instance + * variable, which uses autowiring by type. As an alternative, we + * could annotate clinic with + * {@link javax.annotation.Resource @Resource} to achieve dependency injection + * by name. + * (see: {@link ContextConfiguration @ContextConfiguration}, + * {@link org.springframework.test.context.support.DependencyInjectionTestExecutionListener DependencyInjectionTestExecutionListener})
    • + *
  • Transaction management, meaning each test method is + * executed in its own transaction, which is automatically rolled back by + * default. Thus, even if tests insert or otherwise change database state, there + * is no need for a teardown or cleanup script. + * (see: {@link org.springframework.test.context.transaction.TransactionConfiguration @TransactionConfiguration}, + * {@link org.springframework.transaction.annotation.Transactional @Transactional}, + * {@link org.springframework.test.context.transaction.TransactionalTestExecutionListener TransactionalTestExecutionListener})
    • + *
  • Useful inherited protected fields, such as a + * {@link org.springframework.jdbc.core.simple.SimpleJdbcTemplate SimpleJdbcTemplate} + * that can be used to verify database state after test operations or to verify + * the results of queries performed by application code. An + * {@link org.springframework.context.ApplicationContext ApplicationContext} is + * also inherited and can be used for explicit bean lookup if necessary. + * (see: {@link org.springframework.test.context.junit4.AbstractJUnit4SpringContextTests AbstractJUnit4SpringContextTests}, + * {@link AbstractTransactionalJUnit4SpringContextTests})
    • + *
+ *

+ * The Spring TestContext Framework and related unit and integration testing + * support classes are shipped in spring-test.jar. + *

+ * + * @author Ken Krebs + * @author Rod Johnson + * @author Juergen Hoeller + * @author Sam Brannen + */ +@ContextConfiguration +public abstract class AbstractClinicTests extends AbstractTransactionalJUnit4SpringContextTests { + + @Autowired + protected Clinic clinic; + + + @Test + public void getVets() { + Collection vets = this.clinic.getVets(); + // Use the inherited countRowsInTable() convenience method (from + // AbstractTransactionalJUnit4SpringContextTests) to verify the results. + assertEquals("JDBC query must show the same number of vets", super.countRowsInTable("VETS"), vets.size()); + Vet v1 = EntityUtils.getById(vets, Vet.class, 2); + assertEquals("Leary", v1.getLastName()); + assertEquals(1, v1.getNrOfSpecialties()); + assertEquals("radiology", (v1.getSpecialties().get(0)).getName()); + Vet v2 = EntityUtils.getById(vets, Vet.class, 3); + assertEquals("Douglas", v2.getLastName()); + assertEquals(2, v2.getNrOfSpecialties()); + assertEquals("dentistry", (v2.getSpecialties().get(0)).getName()); + assertEquals("surgery", (v2.getSpecialties().get(1)).getName()); + } + + @Test + public void getPetTypes() { + Collection petTypes = this.clinic.getPetTypes(); + assertEquals("JDBC query must show the same number of pet types", super.countRowsInTable("TYPES"), + petTypes.size()); + PetType t1 = EntityUtils.getById(petTypes, PetType.class, 1); + assertEquals("cat", t1.getName()); + PetType t4 = EntityUtils.getById(petTypes, PetType.class, 4); + assertEquals("snake", t4.getName()); + } + + @Test + public void findOwners() { + Collection owners = this.clinic.findOwners("Davis"); + assertEquals(2, owners.size()); + owners = this.clinic.findOwners("Daviss"); + assertEquals(0, owners.size()); + } + + @Test + public void loadOwner() { + Owner o1 = this.clinic.loadOwner(1); + assertTrue(o1.getLastName().startsWith("Franklin")); + Owner o10 = this.clinic.loadOwner(10); + assertEquals("Carlos", o10.getFirstName()); + + // XXX: Add programmatic support for ending transactions with the + // TestContext Framework. + + // Check lazy loading, by ending the transaction: + // endTransaction(); + + // Now Owners are "disconnected" from the data store. + // We might need to touch this collection if we switched to lazy loading + // in mapping files, but this test would pick this up. + o1.getPets(); + } + + @Test + public void insertOwner() { + Collection owners = this.clinic.findOwners("Schultz"); + int found = owners.size(); + Owner owner = new Owner(); + owner.setLastName("Schultz"); + this.clinic.storeOwner(owner); + // assertTrue(!owner.isNew()); -- NOT TRUE FOR TOPLINK (before commit) + owners = this.clinic.findOwners("Schultz"); + assertEquals("Verifying number of owners after inserting a new one.", found + 1, owners.size()); + } + + @Test + public void updateOwner() throws Exception { + Owner o1 = this.clinic.loadOwner(1); + String old = o1.getLastName(); + o1.setLastName(old + "X"); + this.clinic.storeOwner(o1); + o1 = this.clinic.loadOwner(1); + assertEquals(old + "X", o1.getLastName()); + } + + @Test + public void loadPet() { + Collection types = this.clinic.getPetTypes(); + Pet p7 = this.clinic.loadPet(7); + assertTrue(p7.getName().startsWith("Samantha")); + assertEquals(EntityUtils.getById(types, PetType.class, 1).getId(), p7.getType().getId()); + assertEquals("Jean", p7.getOwner().getFirstName()); + Pet p6 = this.clinic.loadPet(6); + assertEquals("George", p6.getName()); + assertEquals(EntityUtils.getById(types, PetType.class, 4).getId(), p6.getType().getId()); + assertEquals("Peter", p6.getOwner().getFirstName()); + } + + @Test + public void insertPet() { + Owner o6 = this.clinic.loadOwner(6); + int found = o6.getPets().size(); + Pet pet = new Pet(); + pet.setName("bowser"); + Collection types = this.clinic.getPetTypes(); + pet.setType(EntityUtils.getById(types, PetType.class, 2)); + pet.setBirthDate(new Date()); + o6.addPet(pet); + assertEquals(found + 1, o6.getPets().size()); + // both storePet and storeOwner are necessary to cover all ORM tools + this.clinic.storePet(pet); + this.clinic.storeOwner(o6); + // assertTrue(!pet.isNew()); -- NOT TRUE FOR TOPLINK (before commit) + o6 = this.clinic.loadOwner(6); + assertEquals(found + 1, o6.getPets().size()); + } + + @Test + public void updatePet() throws Exception { + Pet p7 = this.clinic.loadPet(7); + String old = p7.getName(); + p7.setName(old + "X"); + this.clinic.storePet(p7); + p7 = this.clinic.loadPet(7); + assertEquals(old + "X", p7.getName()); + } + + @Test + public void insertVisit() { + Pet p7 = this.clinic.loadPet(7); + int found = p7.getVisits().size(); + Visit visit = new Visit(); + p7.addVisit(visit); + visit.setDescription("test"); + // both storeVisit and storePet are necessary to cover all ORM tools + this.clinic.storeVisit(visit); + this.clinic.storePet(p7); + // assertTrue(!visit.isNew()); -- NOT TRUE FOR TOPLINK (before commit) + p7 = this.clinic.loadPet(7); + assertEquals(found + 1, p7.getVisits().size()); + } + +} diff --git a/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/OwnerTests.java b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/OwnerTests.java new file mode 100644 index 00000000000..84b5f62c6c2 --- /dev/null +++ b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/OwnerTests.java @@ -0,0 +1,27 @@ +package org.springframework.samples.petclinic; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNull; + +import org.junit.Test; + +/** + * JUnit test for the {@link Owner} class. + * + * @author Ken Krebs + */ +public class OwnerTests { + + @Test + public void testHasPet() { + Owner owner = new Owner(); + Pet fido = new Pet(); + fido.setName("Fido"); + assertNull(owner.getPet("Fido")); + assertNull(owner.getPet("fido")); + owner.addPet(fido); + assertEquals(fido, owner.getPet("Fido")); + assertEquals(fido, owner.getPet("fido")); + } + +} diff --git a/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/PetClinicSuiteTests.java b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/PetClinicSuiteTests.java new file mode 100644 index 00000000000..16d23cea957 --- /dev/null +++ b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/PetClinicSuiteTests.java @@ -0,0 +1,29 @@ +package org.springframework.samples.petclinic; + +import org.junit.runner.RunWith; +import org.junit.runners.Suite; +import org.junit.runners.Suite.SuiteClasses; + +import org.springframework.samples.petclinic.hibernate.HibernateClinicTests; +import org.springframework.samples.petclinic.jdbc.SimpleJdbcClinicTests; +import org.springframework.samples.petclinic.jpa.EntityManagerClinicTests; +import org.springframework.samples.petclinic.jpa.HibernateEntityManagerClinicTests; +import org.springframework.samples.petclinic.jpa.OpenJpaEntityManagerClinicTests; + +/** + * JUnit 4 based test suite for all PetClinic tests. + * + * @author Sam Brannen + */ +@RunWith(Suite.class) +@SuiteClasses({ + OwnerTests.class, + SimpleJdbcClinicTests.class, + HibernateClinicTests.class, + EntityManagerClinicTests.class, + HibernateEntityManagerClinicTests.class, + OpenJpaEntityManagerClinicTests.class +}) +public class PetClinicSuiteTests { + +} diff --git a/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/hibernate/HibernateClinicTests-context.xml b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/hibernate/HibernateClinicTests-context.xml new file mode 100644 index 00000000000..190823e6103 --- /dev/null +++ b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/hibernate/HibernateClinicTests-context.xml @@ -0,0 +1,30 @@ + + + + + + + + + ${hibernate.dialect} + ${hibernate.show_sql} + + + + + + + + + + + + + + + + diff --git a/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/hibernate/HibernateClinicTests.java b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/hibernate/HibernateClinicTests.java new file mode 100644 index 00000000000..3c275c820b2 --- /dev/null +++ b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/hibernate/HibernateClinicTests.java @@ -0,0 +1,20 @@ +package org.springframework.samples.petclinic.hibernate; + +import org.springframework.samples.petclinic.AbstractClinicTests; +import org.springframework.test.context.ContextConfiguration; + +/** + *

+ * Integration tests for the {@link HibernateClinic} implementation. + *

+ *

+ * "HibernateClinicTests-context.xml" determines the actual beans to test. + *

+ * + * @author Juergen Hoeller + * @author Sam Brannen + */ +@ContextConfiguration +public class HibernateClinicTests extends AbstractClinicTests { + +} diff --git a/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jdbc/SimpleJdbcClinicTests-context.xml b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jdbc/SimpleJdbcClinicTests-context.xml new file mode 100644 index 00000000000..81a536988bc --- /dev/null +++ b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jdbc/SimpleJdbcClinicTests-context.xml @@ -0,0 +1,11 @@ + + + + + + + + diff --git a/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jdbc/SimpleJdbcClinicTests.java b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jdbc/SimpleJdbcClinicTests.java new file mode 100644 index 00000000000..709100d1a12 --- /dev/null +++ b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jdbc/SimpleJdbcClinicTests.java @@ -0,0 +1,19 @@ +package org.springframework.samples.petclinic.jdbc; + +import org.springframework.samples.petclinic.AbstractClinicTests; +import org.springframework.test.context.ContextConfiguration; + +/** + *

+ * Integration tests for the {@link SimpleJdbcClinic} implementation. + *

+ *

+ * "SimpleJdbcClinicTests-context.xml" determines the actual beans to test. + *

+ * + * @author Thomas Risberg + */ +@ContextConfiguration +public class SimpleJdbcClinicTests extends AbstractClinicTests { + +} diff --git a/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/AbstractJpaClinicTests.java b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/AbstractJpaClinicTests.java new file mode 100644 index 00000000000..251af819d16 --- /dev/null +++ b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/AbstractJpaClinicTests.java @@ -0,0 +1,199 @@ + +package org.springframework.samples.petclinic.jpa; + +import java.util.Collection; +import java.util.Date; + +import javax.persistence.EntityManager; + +import org.springframework.jdbc.core.simple.SimpleJdbcTemplate; +import org.springframework.samples.petclinic.Clinic; +import org.springframework.samples.petclinic.Owner; +import org.springframework.samples.petclinic.Pet; +import org.springframework.samples.petclinic.PetType; +import org.springframework.samples.petclinic.Vet; +import org.springframework.samples.petclinic.Visit; +import org.springframework.samples.petclinic.util.EntityUtils; +import org.springframework.test.annotation.ExpectedException; +import org.springframework.test.jpa.AbstractJpaTests; + +/** + *

+ * This class extends {@link AbstractJpaTests}, one of the valuable test + * superclasses provided in the org.springframework.test package. + * This represents best practice for integration tests with Spring for JPA based + * tests which require shadow class loading. For all other types of + * integration testing, the Spring TestContext Framework is + * preferred. + *

+ *

+ * AbstractJpaTests and its superclasses provide the following services: + *

    + *
  • Injects test dependencies, meaning that we don't need to perform + * application context lookups. See the setClinic() method. Injection uses + * autowiring by type.
    • + *
  • Executes each test method in its own transaction, which is automatically + * rolled back by default. This means that even if tests insert or otherwise + * change database state, there is no need for a teardown or cleanup script.
    • + *
  • Provides useful inherited protected fields, such as a + * {@link SimpleJdbcTemplate} that can be used to verify database state after + * test operations, or verify the results of queries performed by application + * code. Alternatively, you can use protected convenience methods such as + * {@link #countRowsInTable(String)}, {@link #deleteFromTables(String[])}, + * etc. An ApplicationContext is also inherited, and can be used for explicit + * lookup if necessary.
    • + *
+ *

+ * {@link AbstractJpaTests} and related classes are shipped in + * spring-test.jar. + *

+ * + * @author Rod Johnson + * @author Sam Brannen + * @see AbstractJpaTests + */ +public abstract class AbstractJpaClinicTests extends AbstractJpaTests { + + protected Clinic clinic; + + + /** + * This method is provided to set the Clinic instance being tested by the + * Dependency Injection injection behaviour of the superclass from the + * org.springframework.test package. + * + * @param clinic clinic to test + */ + public void setClinic(Clinic clinic) { + this.clinic = clinic; + } + + @ExpectedException(IllegalArgumentException.class) + public void testBogusJpql() { + this.sharedEntityManager.createQuery("SELECT RUBBISH FROM RUBBISH HEAP").executeUpdate(); + } + + public void testApplicationManaged() { + EntityManager appManaged = this.entityManagerFactory.createEntityManager(); + appManaged.joinTransaction(); + } + + public void testGetVets() { + Collection vets = this.clinic.getVets(); + // Use the inherited countRowsInTable() convenience method (from + // AbstractTransactionalDataSourceSpringContextTests) to verify the + // results. + assertEquals("JDBC query must show the same number of vets", super.countRowsInTable("VETS"), vets.size()); + Vet v1 = EntityUtils.getById(vets, Vet.class, 2); + assertEquals("Leary", v1.getLastName()); + assertEquals(1, v1.getNrOfSpecialties()); + assertEquals("radiology", (v1.getSpecialties().get(0)).getName()); + Vet v2 = EntityUtils.getById(vets, Vet.class, 3); + assertEquals("Douglas", v2.getLastName()); + assertEquals(2, v2.getNrOfSpecialties()); + assertEquals("dentistry", (v2.getSpecialties().get(0)).getName()); + assertEquals("surgery", (v2.getSpecialties().get(1)).getName()); + } + + public void testGetPetTypes() { + Collection petTypes = this.clinic.getPetTypes(); + assertEquals("JDBC query must show the same number of pet types", super.countRowsInTable("TYPES"), + petTypes.size()); + PetType t1 = EntityUtils.getById(petTypes, PetType.class, 1); + assertEquals("cat", t1.getName()); + PetType t4 = EntityUtils.getById(petTypes, PetType.class, 4); + assertEquals("snake", t4.getName()); + } + + public void testFindOwners() { + Collection owners = this.clinic.findOwners("Davis"); + assertEquals(2, owners.size()); + owners = this.clinic.findOwners("Daviss"); + assertEquals(0, owners.size()); + } + + public void testLoadOwner() { + Owner o1 = this.clinic.loadOwner(1); + assertTrue(o1.getLastName().startsWith("Franklin")); + Owner o10 = this.clinic.loadOwner(10); + assertEquals("Carlos", o10.getFirstName()); + + // Check lazy loading, by ending the transaction + endTransaction(); + + // Now Owners are "disconnected" from the data store. + // We might need to touch this collection if we switched to lazy loading + // in mapping files, but this test would pick this up. + o1.getPets(); + } + + public void testInsertOwner() { + Collection owners = this.clinic.findOwners("Schultz"); + int found = owners.size(); + Owner owner = new Owner(); + owner.setLastName("Schultz"); + this.clinic.storeOwner(owner); + // assertTrue(!owner.isNew()); -- NOT TRUE FOR TOPLINK (before commit) + owners = this.clinic.findOwners("Schultz"); + assertEquals(found + 1, owners.size()); + } + + public void testUpdateOwner() throws Exception { + Owner o1 = this.clinic.loadOwner(1); + String old = o1.getLastName(); + o1.setLastName(old + "X"); + this.clinic.storeOwner(o1); + o1 = this.clinic.loadOwner(1); + assertEquals(old + "X", o1.getLastName()); + } + + public void testLoadPet() { + Collection types = this.clinic.getPetTypes(); + Pet p7 = this.clinic.loadPet(7); + assertTrue(p7.getName().startsWith("Samantha")); + assertEquals(EntityUtils.getById(types, PetType.class, 1).getId(), p7.getType().getId()); + assertEquals("Jean", p7.getOwner().getFirstName()); + Pet p6 = this.clinic.loadPet(6); + assertEquals("George", p6.getName()); + assertEquals(EntityUtils.getById(types, PetType.class, 4).getId(), p6.getType().getId()); + assertEquals("Peter", p6.getOwner().getFirstName()); + } + + public void testInsertPet() { + Owner o6 = this.clinic.loadOwner(6); + int found = o6.getPets().size(); + Pet pet = new Pet(); + pet.setName("bowser"); + Collection types = this.clinic.getPetTypes(); + pet.setType(EntityUtils.getById(types, PetType.class, 2)); + pet.setBirthDate(new Date()); + o6.addPet(pet); + assertEquals(found + 1, o6.getPets().size()); + this.clinic.storeOwner(o6); + // assertTrue(!pet.isNew()); -- NOT TRUE FOR TOPLINK (before commit) + o6 = this.clinic.loadOwner(6); + assertEquals(found + 1, o6.getPets().size()); + } + + public void testUpdatePet() throws Exception { + Pet p7 = this.clinic.loadPet(7); + String old = p7.getName(); + p7.setName(old + "X"); + this.clinic.storePet(p7); + p7 = this.clinic.loadPet(7); + assertEquals(old + "X", p7.getName()); + } + + public void testInsertVisit() { + Pet p7 = this.clinic.loadPet(7); + int found = p7.getVisits().size(); + Visit visit = new Visit(); + p7.addVisit(visit); + visit.setDescription("test"); + this.clinic.storePet(p7); + // assertTrue(!visit.isNew()); -- NOT TRUE FOR TOPLINK (before commit) + p7 = this.clinic.loadPet(7); + assertEquals(found + 1, p7.getVisits().size()); + } + +} diff --git a/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/EntityManagerClinicTests.java b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/EntityManagerClinicTests.java new file mode 100644 index 00000000000..67c472fdeea --- /dev/null +++ b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/EntityManagerClinicTests.java @@ -0,0 +1,51 @@ +package org.springframework.samples.petclinic.jpa; + +import java.util.List; + +import org.springframework.samples.petclinic.aspects.UsageLogAspect; + +/** + *

+ * Tests for the DAO variant based on the shared EntityManager approach. Uses + * TopLink Essentials (the reference implementation) for testing. + *

+ *

+ * Specifically tests usage of an orm.xml file, loaded by the + * persistence provider through the Spring-provided persistence unit root URL. + *

+ * + * @author Rod Johnson + * @author Juergen Hoeller + */ +public class EntityManagerClinicTests extends AbstractJpaClinicTests { + + private UsageLogAspect usageLogAspect; + + public void setUsageLogAspect(UsageLogAspect usageLogAspect) { + this.usageLogAspect = usageLogAspect; + } + + @Override + protected String[] getConfigPaths() { + return new String[] { + "applicationContext-jpaCommon.xml", + "applicationContext-toplinkAdapter.xml", + "applicationContext-entityManager.xml" + }; + } + + public void testUsageLogAspectIsInvoked() { + String name1 = "Schuurman"; + String name2 = "Greenwood"; + String name3 = "Leau"; + + assertTrue(this.clinic.findOwners(name1).isEmpty()); + assertTrue(this.clinic.findOwners(name2).isEmpty()); + + List namesRequested = this.usageLogAspect.getNamesRequested(); + assertTrue(namesRequested.contains(name1)); + assertTrue(namesRequested.contains(name2)); + assertFalse(namesRequested.contains(name3)); + } + +} diff --git a/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/HibernateEntityManagerClinicTests.java b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/HibernateEntityManagerClinicTests.java new file mode 100644 index 00000000000..d95b452e17c --- /dev/null +++ b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/HibernateEntityManagerClinicTests.java @@ -0,0 +1,26 @@ +package org.springframework.samples.petclinic.jpa; + +/** + *

+ * Tests for the DAO variant based on the shared EntityManager approach, using + * Hibernate EntityManager for testing instead of the reference implementation. + *

+ *

+ * Specifically tests usage of an orm.xml file, loaded by the + * persistence provider through the Spring-provided persistence unit root URL. + *

+ * + * @author Juergen Hoeller + */ +public class HibernateEntityManagerClinicTests extends EntityManagerClinicTests { + + @Override + protected String[] getConfigPaths() { + return new String[] { + "applicationContext-jpaCommon.xml", + "applicationContext-hibernateAdapter.xml", + "applicationContext-entityManager.xml" + }; + } + +} diff --git a/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/OpenJpaEntityManagerClinicTests.java b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/OpenJpaEntityManagerClinicTests.java new file mode 100644 index 00000000000..98e38ed6134 --- /dev/null +++ b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/OpenJpaEntityManagerClinicTests.java @@ -0,0 +1,27 @@ + +package org.springframework.samples.petclinic.jpa; + +/** + *

+ * Tests for the DAO variant based on the shared EntityManager approach, using + * Apache OpenJPA for testing instead of the reference implementation. + *

+ *

+ * Specifically tests usage of an orm.xml file, loaded by the + * persistence provider through the Spring-provided persistence unit root URL. + *

+ * + * @author Juergen Hoeller + */ +public class OpenJpaEntityManagerClinicTests extends EntityManagerClinicTests { + + @Override + protected String[] getConfigPaths() { + return new String[] { + "applicationContext-jpaCommon.xml", + "applicationContext-openJpaAdapter.xml", + "applicationContext-entityManager.xml" + }; + } + +} diff --git a/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/applicationContext-entityManager.xml b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/applicationContext-entityManager.xml new file mode 100644 index 00000000000..a9d25738584 --- /dev/null +++ b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/applicationContext-entityManager.xml @@ -0,0 +1,16 @@ + + + + + + + + + + + + diff --git a/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/applicationContext-hibernateAdapter.xml b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/applicationContext-hibernateAdapter.xml new file mode 100644 index 00000000000..447d1bce08f --- /dev/null +++ b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/applicationContext-hibernateAdapter.xml @@ -0,0 +1,9 @@ + + + + + + diff --git a/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/applicationContext-jpaCommon.xml b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/applicationContext-jpaCommon.xml new file mode 100644 index 00000000000..ccc4c096fea --- /dev/null +++ b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/applicationContext-jpaCommon.xml @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + diff --git a/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/applicationContext-openJpaAdapter.xml b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/applicationContext-openJpaAdapter.xml new file mode 100644 index 00000000000..8f6f7c4427c --- /dev/null +++ b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/applicationContext-openJpaAdapter.xml @@ -0,0 +1,9 @@ + + + + + + diff --git a/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/applicationContext-toplinkAdapter.xml b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/applicationContext-toplinkAdapter.xml new file mode 100644 index 00000000000..ac031de8e14 --- /dev/null +++ b/org.springframework.samples.petclinic/src/test/java/org/springframework/samples/petclinic/jpa/applicationContext-toplinkAdapter.xml @@ -0,0 +1,9 @@ + + + + + + diff --git a/org.springframework.samples.petclinic/src/test/resources/log4j.xml b/org.springframework.samples.petclinic/src/test/resources/log4j.xml new file mode 100644 index 00000000000..767b96d6206 --- /dev/null +++ b/org.springframework.samples.petclinic/src/test/resources/log4j.xml @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file