Spring/spring-integration-extensions
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add Spring Integration Print Adapter

Browse Source
This commit is contained in:
Gunnar Hillert
2012-06-22 09:34:57 -04:00
parent 1f282a1824
commit a47fd8524a
46 changed files with 1995 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
spring-integration-print/src/api/overview.html Normal file
View File

@@ -0,0 +1,22 @@
<html>
<body>
This document is the API specification for Spring Integration
<hr/>
<div id="overviewBody">
<p>
For further API reference and developer documentation, see the
<a href="http://static.springsource.org/spring-integration/reference" target="_top">Spring
Integration reference documentation</a>.
That documentation contains more detailed, developer-targeted
descriptions, with conceptual overviews, definitions of terms,
workarounds, and working code examples.
</p>
<p>
If you are interested in commercial training, consultancy, and
support for Spring Integration, please visit <a href="http://www.springsource.com" target="_top">
http://www.springsource.com</a>
</p>
</div>
</body>
</html>

15
spring-integration-print/src/dist/changelog.txt vendored Normal file
View File

@@ -0,0 +1,15 @@
Spring Integration Print Adapter CHANGELOG
=========================================
For the full detailed changelog, see:
https://....
Changes in version 1.0 GA (insert date here)
https://....
*** GENERAL ***
Upgraded Spring Framework dependency to ...
...

201
spring-integration-print/src/dist/license.txt vendored Normal file
View File

@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

21
spring-integration-print/src/dist/notice.txt vendored Normal file
View File

@@ -0,0 +1,21 @@
========================================================================
== NOTICE file corresponding to section 4 d of the Apache License, ==
== Version 2.0, in this case for the Spring Integration distribution. ==
========================================================================
This product includes software developed by
the Apache Software Foundation (http://www.apache.org).
The end-user documentation included with a redistribution, if any,
must include the following acknowledgement:
"This product includes software developed by the Spring Framework
Project (http://www.springframework.org)."
Alternatively, this acknowledgement may appear in the software itself,
if and wherever such third-party acknowledgements normally appear.
The names "Spring", "Spring Framework", and "Spring Integration" must
not be used to endorse or promote products derived from this software
without prior written permission. For written permission, please contact
enquiries@springsource.com.

13
spring-integration-print/src/dist/readme.txt vendored Normal file
View File

@@ -0,0 +1,13 @@
Spring Integration Print Adapter
-----------------------------------
To find out what has changed since any earlier releases, see 'changelog.txt'.
Please consult the documentation located within the 'docs/reference' directory
of this release and also visit the official Spring Integration home at
http://www.springsource.org/spring-integration
There you will find links to the forum, issue tracker, and several other resources.
See https://github.com/SpringSource/spring-integration#readme for additional
information including instructions on building from source.

36
spring-integration-print/src/main/java/org/springframework/integration/print/PrintHeaders.java Normal file
View File

@@ -0,0 +1,36 @@
/*
* Copyright 2002-2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.integration.print;
/**
* Print adapter specific message headers.
*
* @author Gunnar Hillert
* @since 1.0
*/
public class PrintHeaders {
private static final String PREFIX = "print_";
public static final String EXAMPLE = PREFIX + "example_";
/** Noninstantiable utility class */
private PrintHeaders() {
throw new AssertionError();
}
}

35
spring-integration-print/src/main/java/org/springframework/integration/print/config/xml/PrintNamespaceHandler.java Normal file
View File

@@ -0,0 +1,35 @@
/*
* Copyright 2002-2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.integration.print.config.xml;
import org.springframework.integration.config.xml.AbstractIntegrationNamespaceHandler;
/**
* The namespace handler for the Print namespace
*
* @author Gunnar Hillert
* @since 1.0
*
*/
public class PrintNamespaceHandler extends AbstractIntegrationNamespaceHandler {
/* (non-Javadoc)
* @see org.springframework.beans.factory.xml.NamespaceHandler#init()
*/
public void init() {
this.registerBeanDefinitionParser("outbound-channel-adapter", new PrintOutboundChannelAdapterParser());
}
}

77
spring-integration-print/src/main/java/org/springframework/integration/print/config/xml/PrintOutboundChannelAdapterParser.java Normal file
View File

@@ -0,0 +1,77 @@
/*
* Copyright 2002-2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.integration.print.config.xml;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.integration.config.xml.AbstractOutboundChannelAdapterParser;
import org.springframework.integration.config.xml.IntegrationNamespaceUtils;
import org.springframework.integration.print.outbound.PrintMessageHandler;
import org.springframework.integration.print.support.PrintSides;
import org.springframework.util.StringUtils;
import org.w3c.dom.Element;
/**
* The parser for the Print Outbound Channel Adapter.
*
* @author Gunnar Hillert
* @since 2.2
*
*/
public class PrintOutboundChannelAdapterParser extends AbstractOutboundChannelAdapterParser {
@Override
protected boolean shouldGenerateId() {
return false;
}
@Override
protected boolean shouldGenerateIdAsFallback() {
return true;
}
@Override
protected AbstractBeanDefinition parseConsumer(Element element, ParserContext parserContext) {
final BeanDefinitionBuilder printOutboundChannelAdapterBuilder = BeanDefinitionBuilder.genericBeanDefinition(PrintMessageHandler.class);
String docFlavor = element.getAttribute("doc-flavor");
String mimeType = element.getAttribute("mime-type");
if ((StringUtils.hasText(docFlavor) && !StringUtils.hasText(mimeType))
|| (!StringUtils.hasText(docFlavor) && StringUtils.hasText(mimeType))) {
parserContext.getReaderContext().error("Both the 'doc-flavor' and the 'mime-type' attribute are required", element);
}
else if (StringUtils.hasText(docFlavor) && StringUtils.hasText(mimeType)) {
printOutboundChannelAdapterBuilder.addConstructorArgValue(mimeType);
printOutboundChannelAdapterBuilder.addConstructorArgValue(docFlavor);
}
String sides = element.getAttribute("sides");
PrintSides printSides = PrintSides.fromString(sides);
printOutboundChannelAdapterBuilder.addPropertyValue("sides", printSides.getSides());
IntegrationNamespaceUtils.setValueIfAttributeDefined(printOutboundChannelAdapterBuilder, element, "copies");
return printOutboundChannelAdapterBuilder.getBeanDefinition();
}
}

62
spring-integration-print/src/main/java/org/springframework/integration/print/config/xml/PrintParserUtils.java Normal file
View File

@@ -0,0 +1,62 @@
/*
* Copyright 2002-2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.integration.print.config.xml;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.integration.print.core.PrintExecutor;
import org.springframework.util.Assert;
import org.w3c.dom.Element;
/**
* Contains various utility methods for parsing Print Adapter
* specific namesspace elements as well as for the generation of the the
* respective {@link BeanDefinition}s.
*
* @author Gunnar Hillert
* @since 1.0
*
*/
public final class PrintParserUtils {
/** Prevent instantiation. */
private PrintParserUtils() {
throw new AssertionError();
}
/**
* Create a new {@link BeanDefinitionBuilder} for the class {@link PrintExecutor}.
* Initialize the wrapped {@link PrintExecutor} with common properties.
*
* @param element Must not be null
* @param parserContext Must not be null
* @return The BeanDefinitionBuilder for the PrintExecutor
*/
public static BeanDefinitionBuilder getPrintExecutorBuilder(final Element element,
final ParserContext parserContext) {
Assert.notNull(element, "The provided element must not be null.");
Assert.notNull(parserContext, "The provided parserContext must not be null.");
final BeanDefinitionBuilder printExecutorBuilder = BeanDefinitionBuilder.genericBeanDefinition(PrintExecutor.class);
return printExecutorBuilder;
}
}

4
spring-integration-print/src/main/java/org/springframework/integration/print/config/xml/package-info.java Normal file
View File

@@ -0,0 +1,4 @@
/**
* Provides parser classes to provide Xml namespace support for the Print components.
*/
package org.springframework.integration.print.config.xml;

98
spring-integration-print/src/main/java/org/springframework/integration/print/core/PrintExecutor.java Normal file
View File

@@ -0,0 +1,98 @@
/*
* Copyright 2002-2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.integration.print.core;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.integration.Message;
import org.springframework.integration.support.MessageBuilder;
import org.springframework.util.Assert;
/**
* Bundles common core logic for the Print components.
*
* @author Gunnar Hillert
* @since 1.0
*
*/
public class PrintExecutor implements InitializingBean {
private static final Log logger = LogFactory.getLog(PrintExecutor.class);
private volatile String exampleProperty;
/**
* Constructor.
*/
public PrintExecutor() {}
/**
* Verifies and sets the parameters. E.g. initializes the to be used
*/
public void afterPropertiesSet() {
Assert.hasText(this.exampleProperty, "exampleProperty must not be empty.");
}
/**
* Executes the outbound Print Operation.
*
*/
public Object executeOutboundOperation(final Message<?> message) {
if (logger.isWarnEnabled()) {
logger.warn("Logic not implemented, yet.");
}
return message.getPayload();
}
/**
* Execute the Print operation. Delegates to
* {@link PrintExecutor#poll(Message)}.
*/
public Object poll() {
return poll(null);
}
/**
* Execute a retrieving (polling) Print operation.
*
* @param requestMessage May be null.
* @return The payload object, which may be null.
*/
public Object poll(final Message<?> requestMessage) {
if (logger.isWarnEnabled()) {
logger.warn("Logic not implemented, yet.");
}
return MessageBuilder.fromMessage(requestMessage).build();
}
/**
* Example property to illustrate usage of properties in Spring Integration
* components. Replace with your own logic.
*
* @param exampleProperty Must not be null
*/
public void setExampleProperty(String exampleProperty) {
Assert.hasText(exampleProperty, "exampleProperty must be neither null nor empty");
this.exampleProperty = exampleProperty;
}
}

4
spring-integration-print/src/main/java/org/springframework/integration/print/core/package-info.java Normal file
View File

@@ -0,0 +1,4 @@
/**
* Provides core classes of the Print module.
*/
package org.springframework.integration.print.core;

97
spring-integration-print/src/main/java/org/springframework/integration/print/outbound/PrintMessageHandler.java Normal file
View File

@@ -0,0 +1,97 @@
/*
* Copyright 2002-2012 the original author or authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.integration.print.outbound;
import javax.print.Doc;
import javax.print.DocFlavor;
import javax.print.DocPrintJob;
import javax.print.PrintService;
import javax.print.PrintServiceLookup;
import javax.print.SimpleDoc;
import javax.print.attribute.HashPrintRequestAttributeSet;
import javax.print.attribute.PrintRequestAttributeSet;
import javax.print.attribute.standard.Copies;
import javax.print.attribute.standard.Sides;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.integration.Message;
import org.springframework.integration.handler.AbstractMessageHandler;
import org.springframework.util.Assert;
/**
* Simple adapter to support printing of payloads.
*
* @author Gunnar Hillert
* @since 2.2
*/
public class PrintMessageHandler extends AbstractMessageHandler {
private static final Log LOG = LogFactory.getLog(PrintMessageHandler.class);
private volatile Sides sides = Sides.ONE_SIDED;
private volatile Copies copies = new Copies(1);
private final DocFlavor docFlavor;
public PrintMessageHandler(String mimeType, String className) {
Assert.hasText(className, "'className' must be neither null nor empty.");
Assert.hasText(mimeType, "'mimeType' must be neither null nor empty.");
this.docFlavor = new DocFlavor(mimeType, className);
}
public PrintMessageHandler() {
this.docFlavor = DocFlavor.BYTE_ARRAY.AUTOSENSE;
}
@Override
protected void handleMessageInternal(Message<?> message) throws Exception {
final PrintService printService = PrintServiceLookup.lookupDefaultPrintService();
Assert.notNull(printService, "Did not find a 'printService'.");
if (LOG.isInfoEnabled()) {
LOG.info("Printing to default printer: " + printService.getName());
}
final Doc doc = new SimpleDoc(((String) message.getPayload()).getBytes(), docFlavor, null);
final PrintRequestAttributeSet attributes = new HashPrintRequestAttributeSet();
attributes.add(copies);
attributes.add(sides);
final DocPrintJob job = printService.createPrintJob();
job.print(doc, attributes);
}
public void setSides(Sides sides) {
Assert.notNull(sides, "'sides' must not be null");
this.sides = sides;
}
public void setCopies(int numberOfCopies) {
Assert.isTrue(numberOfCopies > 0, "'copies' must be greater than 0");
this.copies = new Copies(numberOfCopies);
}
}

4
spring-integration-print/src/main/java/org/springframework/integration/print/outbound/package-info.java Normal file
View File

@@ -0,0 +1,4 @@
/**
* Provides Spring Integration components for doing outbound operations.
*/
package org.springframework.integration.print.outbound;

4
spring-integration-print/src/main/java/org/springframework/integration/print/package-info.java Normal file
View File

@@ -0,0 +1,4 @@
/**
* Root package of the Print Module.
*/
package org.springframework.integration.print;

40
spring-integration-print/src/main/java/org/springframework/integration/print/support/PrintSides.java Normal file
View File

@@ -0,0 +1,40 @@
package org.springframework.integration.print.support;
import javax.print.attribute.standard.Sides;
import org.springframework.util.Assert;
public enum PrintSides {
DUPLEX("DUPLEX", Sides.DUPLEX),
ONE_SIDED("ONE_SIDED", Sides.ONE_SIDED),
TUMBLE("TUMBLE", Sides.TUMBLE),
TWO_SIDED_LONG_EDGE("TWO_SIDED_LONG_EDGE", Sides.TWO_SIDED_LONG_EDGE),
TWO_SIDED_SHORT_EDGE("TWO_SIDED_SHORT_EDGE", Sides.TWO_SIDED_SHORT_EDGE);
private String id;
private Sides sides;
PrintSides(String id, Sides sides) {
this.id = id;
this.sides = sides;
}
public Sides getSides() {
return sides;
}
public static PrintSides fromString(String id) {
Assert.hasText(id, "'Enumeration id must not be null nor empty'");
for (PrintSides printSide : PrintSides.class.getEnumConstants()) {
if (printSide.id.equalsIgnoreCase(id)) {
return printSide;
}
}
throw new IllegalArgumentException(String.format("No enumeration found for id '%s'", id));
}
}

33
spring-integration-print/src/main/java/org/springframework/integration/print/support/PrintUtils.java Normal file
View File

@@ -0,0 +1,33 @@
/*
* Copyright 2002-2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.integration.print.support;
/**
* Contains utility methods used by the Print components.
*
* @author Gunnar Hillert
* @since 1.0
*
*/
public final class PrintUtils {
/** Prevent instantiation. */
private PrintUtils() {
throw new AssertionError();
}
}

4
spring-integration-print/src/main/java/org/springframework/integration/print/support/package-info.java Normal file
View File

@@ -0,0 +1,4 @@
/**
* Provides various support classes used across Spring Integration Print Components.
*/
package org.springframework.integration.print.support;

1
spring-integration-print/src/main/resources/META-INF/spring.handlers Normal file
View File

@@ -0,0 +1 @@
http\://www.springframework.org/schema/integration/print=org.springframework.integration.print.config.xml.PrintNamespaceHandler

2
spring-integration-print/src/main/resources/META-INF/spring.schemas Normal file
View File

@@ -0,0 +1,2 @@
http\://www.springframework.org/schema/integration/print/spring-integration-print-2.2.xsd=org/springframework/integration/print/config/xml/spring-integration-print-2.2.xsd
http\://www.springframework.org/schema/integration/print/spring-integration-print.xsd=org/springframework/integration/print/config/xml/spring-integration-print-2.2.xsd

4
spring-integration-print/src/main/resources/META-INF/spring.tooling Normal file
View File

@@ -0,0 +1,4 @@
# Tooling related information for the integration Print namespace
http\://www.springframework.org/schema/integration/print@name=integration Print Namespace
http\://www.springframework.org/schema/integration/print@prefix=int-print
http\://www.springframework.org/schema/integration/print@icon=org/springframework/integration/print/config/xml/spring-integration-print.gif

139
spring-integration-print/src/main/resources/org/springframework/integration/print/config/xml/spring-integration-print-2.2.xsd Normal file
View File

@@ -0,0 +1,139 @@
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns="http://www.springframework.org/schema/integration/print"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:beans="http://www.springframework.org/schema/beans"
xmlns:tool="http://www.springframework.org/schema/tool"
xmlns:integration="http://www.springframework.org/schema/integration"
targetNamespace="http://www.springframework.org/schema/integration/print"
elementFormDefault="qualified" attributeFormDefault="unqualified">
<xsd:import namespace="http://www.springframework.org/schema/beans" />
<xsd:import namespace="http://www.springframework.org/schema/tool" />
<xsd:import namespace="http://www.springframework.org/schema/integration"
schemaLocation="http://www.springframework.org/schema/integration/spring-integration-2.2.xsd" />
<xsd:annotation>
<xsd:documentation><![CDATA[
Defines the configuration elements for the Spring Integration
Print Adapter.
]]></xsd:documentation>
</xsd:annotation>
<xsd:element name="outbound-channel-adapter">
<xsd:annotation>
<xsd:documentation>
Defines a Print Outbound Channel Adapter, allowing you
to send payloadds to a connected printer using the Java
Print Service API.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="integration:poller" minOccurs="0" maxOccurs="1" />
</xsd:sequence>
<xsd:attributeGroup ref="corePrintComponentAttributes"/>
<xsd:attribute name="channel" type="xsd:string">
<xsd:annotation>
<xsd:appinfo>
<xsd:documentation>
Channel from which messages will be printed.
When a message is sent to this channel it will
cause the payload to be printed.
</xsd:documentation>
<tool:annotation kind="ref">
<tool:expected-type type="org.springframework.integration.MessageChannel" />
</tool:annotation>
</xsd:appinfo>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="order">
<xsd:annotation>
<xsd:documentation>
Specifies the order for invocation when this endpoint is connected as a
subscriber to a SubscribableChannel.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:attributeGroup name="corePrintComponentAttributes">
<xsd:attribute name="id" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
Identifies the underlying Spring bean definition, which is an
instance of either 'EventDrivenConsumer' or 'PollingConsumer',
depending on whether the component's input channel is a
'SubscribableChannel' or 'PollableChannel'.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="auto-startup" default="true" use="optional">
<xsd:annotation>
<xsd:documentation>
Flag to indicate that the component should start automatically
on startup (default true).
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:union memberTypes="xsd:boolean xsd:string" />
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="copies" use="optional" type="xsd:integer" default="1">
<xsd:annotation>
<xsd:documentation>
The number of copies to print. Defaults to 1 if not set.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="sides" use="optional" default="ONE_SIDED">
<xsd:annotation>
<xsd:documentation><![CDATA[
Defaults to single side if not specified.
]]></xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:union memberTypes="sides xsd:string"/>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="doc-flavor" use="optional">
<xsd:annotation>
<xsd:documentation><![CDATA[
Defaults to single side if not specified.
]]></xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:union memberTypes="doc-flavor xsd:string"/>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="mime-type" use="optional" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:attributeGroup>
<xsd:simpleType name="sides">
<xsd:restriction base="xsd:token">
<xsd:enumeration value="ONE_SIDED"/>
<xsd:enumeration value="DUPLEX"/>
<xsd:enumeration value="TUMBLE"/>
<xsd:enumeration value="TWO_SIDED_LONG_EDGE"/>
<xsd:enumeration value="TWO_SIDED_SHORT_EDGE"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="doc-flavor">
<xsd:restriction base="xsd:token">
<xsd:enumeration value="INPUT_STREAM"/>
<xsd:enumeration value="BYTE_ARRAY"/>
<xsd:enumeration value="CHAR_ARRAY"/>
<xsd:enumeration value="READER"/>
<xsd:enumeration value="SERVICE_FORMATTED"/>
<xsd:enumeration value="java.lang.String"/>
<xsd:enumeration value="URL"/>
<xsd:enumeration value="INPUT_STREAM"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:schema>

BIN
spring-integration-print/src/main/resources/org/springframework/integration/print/config/xml/spring-integration-print.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 572 B

73
spring-integration-print/src/reference/docbook/SIAdapterLowerPrefix.xml Normal file
View File

@@ -0,0 +1,73 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="SIAdapterLowerPrefix"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Print Adapter</title>
<para>
The Spring Integration Print Adapter provides...
</para>
<itemizedlist>
<listitem>
<para><emphasis><link linkend='SIAdapterLowerPrefix-outbound-channel-adapter'>Outbound Channel adapter</link></emphasis></para>
</listitem>
<listitem>
<para><emphasis><link linkend='SIAdapterLowerPrefix-outbound-gateway'>Outbound Gateway</link></emphasis></para>
</listitem>
<listitem>
<para><emphasis><link linkend='SIAdapterLowerPrefix-inbound-channel-adapter'>Inbound Channel Adapter</link></emphasis></para>
</listitem>
</itemizedlist>
<section id="jpa-java-implementation">
<title>Java Implementation</title>
<para>Each of the provided components will use the
<classname>org.springframework.integration.print.core.PrintExecutor</classname>
class...
</para>
</section>
<section id="jpa-common-configuration-attributes">
<title>Common Configuration Attributes</title>
<para>
Certain configuration parameters are shared amongst all Print
components and are described below:
</para>
<para><emphasis role="bold">auto-startup</emphasis></para>
<para>
Lifecycle attribute signaling if this component should
be started during Application Context startup.
Defaults to <code>true</code>.
<emphasis>Optional</emphasis>.
</para>
<para><emphasis role="bold">id</emphasis></para>
<para>
Identifies the underlying Spring bean definition, which
is an instance of either <classname>EventDrivenConsumer</classname>
or <classname>PollingConsumer</classname>.
<emphasis>Optional</emphasis>.
</para>
</section>
<section id="SIAdapterLowerPrefix-outbound-channel-adapter">
<title>Outbound Channel Adapter</title>
<para>
The Print Outbound channel adapter allows you to...
</para>
</section>
<section id="SIAdapterLowerPrefix-outbound-gateway">
<title>Outbound Gateway</title>
<para>
Outbound gateways are similar to outbound channel adapters except that it can also be used to
get a result on the <emphasis>reply channel</emphasis> after performing
the given...
</para>
</section>
<section id="SIAdapterLowerPrefix-inbound-channel-adapter">
<title>Inbound Channel Adapter</title>
<para>
An inbound channel adapter is used to execute...
</para>
</section>
</chapter>

8
spring-integration-print/src/reference/docbook/history.xml Normal file
View File

@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<appendix xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="history"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude">
<title>Change History</title>
</appendix>

BIN
spring-integration-print/src/reference/docbook/images/logo.png Normal file
View File

Binary file not shown.

68
spring-integration-print/src/reference/docbook/index.xml Normal file
View File

@@ -0,0 +1,68 @@
<?xml version="1.0" encoding="UTF-8"?>
<book xmlns="http://docbook.org/ns/docbook" version="5.0"
xml:id="spring-integration-reference" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink">
<bookinfo>
<title>Spring Integration Print Adapter</title>
<titleabbrev>Print Adapter ${version}</titleabbrev>
<productname>Spring Integration</productname>
<releaseinfo>${version}</releaseinfo>
<!-- TODO: this isn't showing up. -->
<mediaobject>
<imageobject role="fo">
<imagedata fileref="images/logo.png" format="PNG" align="center" />
</imageobject>
<imageobject role="html">
<imagedata fileref="images/logo.png" format="PNG" align="center" />
</imageobject>
</mediaobject>
<!-- END TODO -->
<authorgroup>
<author><firstname>Gunnar Hillert</firstname></author>
</authorgroup>
<legalnotice>
<para>© SpringSource Inc., 2012</para>
</legalnotice>
</bookinfo>
<toc></toc>
<part id="whats-new-part">
<title>What's new?</title>
<partintro id="spring-integration-intro">
<para>
For those who are already familiar with Spring Integration, this
chapter
provides a brief overview of the new features of version 2.2. If you are
interested in the changes and features, that were introduced in
earlier
versions, please take a look at chapter:
<xref linkend="history" />
</para>
</partintro>
<xi:include href="./whats-new.xml" />
</part>
<part id="spring-integration-adapters">
<title>Integration Adapters</title>
<partintro id="spring-integration-adapters">
<para>This section covers the various Channel Adapters and Messaging
Gateways provided
by Spring Integration to support Message-based communication with
external systems.
</para>
</partintro>
<xi:include href="./SIAdapterLowerPrefix.xml" />
</part>
<part id="spring-integration-appendices">
<title>Appendices</title>
<partintro id="spring-integration-adapters">
<para>Advanced Topics and Additional Resources</para>
</partintro>
<xi:include href="./history.xml" />
</part>
</book>

17
spring-integration-print/src/reference/docbook/resources.xml Normal file
View File

@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<appendix xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="resources"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Additional Resources</title>
<section id="resources-home">
<title>Spring Integration Home</title>
<para>
The definitive source of information about Spring Integration is the
<ulink url="http://www.springsource.org/spring-integration">Spring Integration Home</ulink> at
<ulink url="http://www.springsource.org">http://www.springsource.org</ulink>. That site serves as a hub of
information and is the best place to find up-to-date announcements about the project as well as links to
articles, blogs, and new sample applications.
</para>
</section>
</appendix>

11
spring-integration-print/src/reference/docbook/whats-new.xml Normal file
View File

@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="whats-new"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>What's new?</title>
<para>
This chapter provides an overview of the new features and improvements
that have been added to the Print Adapter:
</para>
</chapter>

38
spring-integration-print/src/test/java/org/springframework/integration/print/PrintTests.java Normal file
View File

@@ -0,0 +1,38 @@
package org.springframework.integration.print;
import java.io.FileNotFoundException;
import java.io.InputStream;
import javax.print.Doc;
import javax.print.DocFlavor;
import javax.print.DocPrintJob;
import javax.print.PrintException;
import javax.print.PrintService;
import javax.print.PrintServiceLookup;
import javax.print.SimpleDoc;
import javax.print.attribute.HashPrintRequestAttributeSet;
import javax.print.attribute.PrintRequestAttributeSet;
import javax.print.attribute.standard.Copies;
import javax.print.attribute.standard.Sides;
public class PrintTests {
public static void main(String args[]) throws FileNotFoundException, PrintException {
InputStream textStream = PrintTests.class.getResourceAsStream("/print.txt");
DocFlavor myFormat = DocFlavor.INPUT_STREAM.AUTOSENSE;
Doc myDoc = new SimpleDoc(textStream, myFormat, null);
PrintRequestAttributeSet aset = new HashPrintRequestAttributeSet();
aset.add(new Copies(1));
aset.add(Sides.ONE_SIDED);
PrintService printService = PrintServiceLookup.lookupDefaultPrintService();
System.out.println("Printing to default printer: " + printService.getName());
DocPrintJob job = printService.createPrintJob();
job.print(myDoc, aset);
}
}

22
spring-integration-print/src/test/java/org/springframework/integration/print/config/xml/PrintMessageHandlerParserTests-context.xml Normal file
View File

@@ -0,0 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:int="http://www.springframework.org/schema/integration"
xmlns:int-print="http://www.springframework.org/schema/integration/print"
xsi:schemaLocation="
http://www.springframework.org/schema/integration http://www.springframework.org/schema/integration/spring-integration.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/integration/print http://www.springframework.org/schema/integration/print/spring-integration-print.xsd">
<int:channel id="input"/>
<int-print:outbound-channel-adapter id="printOutboundChannelAdapter"
copies="14"
doc-flavor="java.lang.String"
mime-type="text/plain; charset=utf-16"
sides="DUPLEX"
auto-startup="true"
order="2"
channel="input">
</int-print:outbound-channel-adapter>
</beans>

66
spring-integration-print/src/test/java/org/springframework/integration/print/config/xml/PrintMessageHandlerParserTests.java Normal file
View File

@@ -0,0 +1,66 @@
/*
* Copyright 2002-2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package org.springframework.integration.print.config.xml;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import javax.print.DocFlavor;
import javax.print.attribute.standard.Copies;
import javax.print.attribute.standard.Sides;
import org.junit.After;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.integration.channel.AbstractMessageChannel;
import org.springframework.integration.core.MessageHandler;
import org.springframework.integration.endpoint.EventDrivenConsumer;
import org.springframework.integration.print.core.PrintExecutor;
import org.springframework.integration.test.util.TestUtils;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
/**
*
* @author Gunnar Hillert
* @since 1.0
*
*/
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration
public class PrintMessageHandlerParserTests {
@Autowired
private MessageHandler messageHandler;
@Test
public void testJpaMessageHandlerParser() throws Exception {
final DocFlavor docFlavor = TestUtils.getPropertyValue(messageHandler, "docFlavor", DocFlavor.class);
assertEquals(DocFlavor.STRING.TEXT_PLAIN, docFlavor);
final Copies copies = TestUtils.getPropertyValue(messageHandler, "copies", Copies.class);
assertEquals(14, copies.getValue());
final Sides sides = TestUtils.getPropertyValue(messageHandler, "sides", Sides.class);
assertEquals(Sides.DUPLEX, sides);
}
}

17
spring-integration-print/src/test/java/org/springframework/integration/print/outbound/PrintMessageHandlerTest.java Normal file
View File

@@ -0,0 +1,17 @@
package org.springframework.integration.print.outbound;
import org.junit.Ignore;
import org.junit.Test;
import org.springframework.integration.support.MessageBuilder;
public class PrintMessageHandlerTest {
//@Test
//@Ignore
public void test() {
PrintMessageHandler handler = new PrintMessageHandler();
handler.handleMessage(MessageBuilder.withPayload("This is a test".getBytes()).build());
}
}

17
spring-integration-print/src/test/java/org/springframework/integration/print/outbound/PrintOutboundChannelAdapterTest-context.xml Normal file
View File

@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:int="http://www.springframework.org/schema/integration"
xmlns:int-print="http://www.springframework.org/schema/integration/print"
xsi:schemaLocation="
http://www.springframework.org/schema/integration http://www.springframework.org/schema/integration/spring-integration.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/integration/print http://www.springframework.org/schema/integration/print/spring-integration-print.xsd">
<int:channel id="input"/>
<int-print:outbound-channel-adapter id="printOutboundChannelAdapter"
channel="input"
copies="1">
</int-print:outbound-channel-adapter>
</beans>

27
spring-integration-print/src/test/java/org/springframework/integration/print/outbound/PrintOutboundChannelAdapterTest.java Normal file
View File

@@ -0,0 +1,27 @@
package org.springframework.integration.print.outbound;
import org.junit.Ignore;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.integration.Message;
import org.springframework.integration.channel.DirectChannel;
import org.springframework.integration.support.MessageBuilder;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration
public class PrintOutboundChannelAdapterTest {
@Autowired
private DirectChannel channel;
@Test
//@Ignore
public void test() {
final Message<String> message = MessageBuilder.withPayload("This is a test.").build();
channel.send(message);
}
}

8
spring-integration-print/src/test/resources/log4j.properties Normal file
View File

@@ -0,0 +1,8 @@
log4j.rootCategory=WARN, stdout
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.category.org.springframework.integration=WARN
log4j.category.org.springframework.integration.print=INFO

1
spring-integration-print/src/test/resources/print.txt Normal file
View File

@@ -0,0 +1 @@
Testing Print Capabilities