DZone
Integration Zone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
  • Refcardz
  • Trend Reports
  • Webinars
  • Zones
  • |
    • Agile
    • AI
    • Big Data
    • Cloud
    • Database
    • DevOps
    • Integration
    • IoT
    • Java
    • Microservices
    • Open Source
    • Performance
    • Security
    • Web Dev
DZone > Integration Zone > Adding Gzip Compression in CXF APIs and Interceptors

Adding Gzip Compression in CXF APIs and Interceptors

Shan Arshad user avatar by
Shan Arshad
·
Nov. 22, 14 · Integration Zone · Interview
Like (1)
Save
Tweet
12.06K Views

Join the DZone community and get the full member experience.

Join For Free

Nowadays it has become mandatory to Gzipping the APIs response due to huge amount of data we are sending in response. It saves network bandwidth and delivery time and off course space over the internet.

While using CXF; it provides an option to use the Gzip Compression in no of ways.

  1. Blueprint
  2. Annotation

Blueprint:

<bean id="gZipInterceptor" class="org.apache.cxf.transport.common.gzip.GZIPOutInterceptor" />
<jaxrs:server id="rsServer" address="/gZip">
<jaxrs:outInterceptors>
<ref component-id="gZipInterceptor" />
</jaxrs:outInterceptors>
</jaxrs:server>

Annotation:

First you need to register the GZIPOutInterceptor in out interceptors list. For that you need to hook into CXF initialization classes.

public class InterceptorManager extends AbstractFeature {

private static final Logger LOGGER = Logger.getLogger( "simcore" );
private static final Interceptor< Message > GZIP = new GZIPOutInterceptor();
//private static final Interceptor< Message > GZIP = new GZIPOutInterceptor(512);

/* (non-Javadoc)
 * @see org.apache.cxf.feature.AbstractFeature#initializeProvider(org.apache.cxf.interceptor.InterceptorProvider, org.apache.cxf.Bus)
 */
@Override
protected void initializeProvider( InterceptorProvider provider, Bus bus ) {
/**
 * Adding Gzip interceptor to all outbound requests/responses
 */
LOGGER.debug( " ##############  Adding Gzip as OUT Interceptor ##############" );

provider.getOutInterceptors().add( GZIP );

}
}

GZIPOutInterceptor comes with an option to set the Threshold value as no of Bytes. If response size will be below this threshold value then it will not be compressed. It is extremely useful when we will be sending empty lists and status messages/codes only. Because compressing those small responses will be overhead at server side.

But there is another factor which is no of users requesting the response. So set this value by thinking over all the cases in mind.

@GZIP

Now we can use this annotation on any of our web-services controller to implement compression on all the APIs provided in that class.

@WebService
@Consumes ( { MediaType.TEXT_PLAIN, MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON } )
@Produces ( MediaType.APPLICATION_JSON )
@GZIP
public interface WebServicesController {

        @GET
@Path ( "/myGzipData" )
@Produces ( { MediaType.APPLICATION_JSON } )
Response getZipData( );

}

Moreover we can set different parameters in Gzip annotation.

@GZIP ( force = true, threshold = 512 )
Annotation Delivery (commerce) Hook Data (computing) Bandwidth (computing) Overhead (computing) Factor (programming language) Internet (web browser) Space (architecture)

Published at DZone with permission of Shan Arshad, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • Product Owner Anti-Patterns
  • Growth in Java Development for Web and Mobile Apps
  • The Right Way to Hybridize Your Product Development Technique
  • The Evolution of Configuration Management: IaC vs. GitOps

Comments

Integration Partner Resources

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • MVB Program
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends:

DZone.com is powered by 

AnswerHub logo